From: Nabil Ghodbane Date: Mon, 15 Jul 2024 13:58:37 +0000 (+0200) Subject: update documentation de release 5.9.0 X-Git-Tag: V9_13_0 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=fa4b7f175ec76dca3d52e4503f96fccd24c6a7b7;p=tools%2Fsat.git update documentation de release 5.9.0 --- diff --git a/doc/rst_prolog.rst b/doc/rst_prolog.rst index 43d943b..b9c98b2 100644 --- a/doc/rst_prolog.rst +++ b/doc/rst_prolog.rst @@ -10,12 +10,11 @@ .. _MATIX: ../../MATIX_PROFILE/doc/index.html .. _C++: http://www.cplusplus.com/ .. _CMake: https://cmake.org/ -.. _Python: https://docs.python.org/2.7 +.. _Python: https://docs.python.org/ .. _ParaView: http://www.paraview.org .. _Anaconda: https://docs.continuum.io/anaconda/pkg-docs# .. _Miniconda: http://conda.pydata.org/miniconda.html .. _Git: https://git-scm.com -.. _GitCheatSheet: https://services.github.com/kit/downloads/github-git-cheat-sheet.pdf .. _SatCheatSheet: ../sat-cheat-sheet.pdf .. _CLI: https://en.wikipedia.org/wiki/Command-line_interface .. _Tar: https://en.wikipedia.org/wiki/Tar_(computing) diff --git a/doc/src/conf.py b/doc/src/conf.py index b4916cb..45763ee 100644 --- a/doc/src/conf.py +++ b/doc/src/conf.py @@ -54,16 +54,16 @@ master_doc = 'index' # General information about the project. project = u'sat' -copyright = u'2019, CEA' +copyright = u'2024, CEA' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '5.8' +version = '5.9' # The full version, including alpha/beta/rc tags. -release = '5.8.0' +release = '5.9.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -260,7 +260,7 @@ latex_show_urls = 'footnote' # sphinx version 1.7 # True # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'sat', u'SAT Documentation', - [u'CEA DES/ISAS/DM2S/STMF/LGLS'], 1) + [u'CEA/SAC/DES/ISAS/DM2S/SGLS/LESIM'], 1) ] diff --git a/doc/src/index.rst b/doc/src/index.rst index dec9d89..3ef294a 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -30,10 +30,10 @@ The following features should be highlighted: * **overwriting** the configuration in command line: it allows users setting easily their own preferences or options SAT uses **python**, and many of its strength come from its power and straightforwardness. It is compatible with both python2 and python3 versions. -SAT is a Command Line Interface (CLI_) based on python language. It is a suite of commands, which are detailed later in this documentation. +SAT is a Command Line Interface (CLI_) based on python language. It is a suite of commands, which are detailed in this documentation. These commands are used to perform the operations on the application. SAT enables command completion by sourcing the provided complete_sat.sh script. -Like similar tool, SAT doesn't like modified environments, as this can cause conflicts while compiling products or using applications. It is recommended that SAT users run with a **clean environment**, especially for PATH, LD_LIBRARY_PATH and PYTHONPATH. ~/.bashrc file should be as thin as possible! +Like similar tools, SAT doesn't like modified environments, as this can cause conflicts while compiling products or using applications. It is recommended that SAT users run with a **clean environment**, especially for PATH, LD_LIBRARY_PATH and PYTHONPATH. ~/.bashrc file should be as thin as possible! Documentation @@ -75,6 +75,7 @@ Release Notes .. toctree:: :maxdepth: 1 + Release Notes 5.9.0 Release Notes 5.8.0 Release Notes 5.7.0 Release Notes 5.6.0 diff --git a/doc/src/release_notes/release_notes_5.9.0.rst b/doc/src/release_notes/release_notes_5.9.0.rst new file mode 100644 index 0000000..78437fd --- /dev/null +++ b/doc/src/release_notes/release_notes_5.9.0.rst @@ -0,0 +1,58 @@ +***************** +SAT version 5.9.0 +***************** + +Release Notes, July 2024 +============================ + + +New features and improvements +----------------------------- + + +**New key git_info.git_server** + +Each project, e.g. salome.pyconf, implements a new section named git_info with various git servers. This new section is introduced in order to cope with different mirrors, like closed and opensource git repositories. +This git_options key should be added in the git_info section of each new project: :: + + git_info : + { + git_server : + { + tuleap : {url : "https://codev-tuleap.cea.fr/plugins/git/", opensource_only: 'no' } + github : {url : "https://github.com/SalomePlatform/", opensource_only: 'yes'} + gitpub : {url : "https://git.salome-platform.org/gitpub/", opensource_only: 'yes'} + } + } + + +**New property APPLICATION.git_server** + +Each application implemented in a given project, defines a new key named git_server, aimed to define the default git server in use. :: + + APPLICATION : + { + properties : + { + git_server : 'tuleap' + } + } + + +**New property APPLICATION.cmake_build_type** + +A new key named cmake_build_type is implemented for cmake based builds only. This variable can be set to Debug, RelWithDebInfo, Release or MinSizeRel. + +The introduction of this key was motivated by the need to be able to compile SALOME in Release with debug information. + +The syntax reads: :: + + APPLICATION : + { + cmake_generator : 'Visual Studio 15 2017' + cmake_build_type: 'Release' # Debug, RelWithDebInfo, Release, MinSizeRel + } + + +This feature can also be used at product level. + diff --git a/pdf/salomeTools.pdf b/pdf/salomeTools.pdf index cbd2b4a..90a1624 100644 Binary files a/pdf/salomeTools.pdf and b/pdf/salomeTools.pdf differ