]> SALOME platform Git repositories - tools/sat.git/commitdiff
Salome HOME
update documentation de release 5.9.0 V9_13_BR V9_13_0
authorNabil Ghodbane <nabil.ghodbane@cea.fr>
Mon, 15 Jul 2024 13:58:37 +0000 (15:58 +0200)
committerNabil Ghodbane <nabil.ghodbane@cea.fr>
Mon, 15 Jul 2024 13:58:37 +0000 (15:58 +0200)
doc/rst_prolog.rst
doc/src/conf.py
doc/src/index.rst
doc/src/release_notes/release_notes_5.9.0.rst [new file with mode: 0644]
pdf/salomeTools.pdf

index 43d943b309c56ed7743bfec29f65d74848035b5e..b9c98b2bb3e9561b450732d35671d0c1e55c80ff 100644 (file)
 .. _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)
index b4916cbcf2b899ca50adb0eb9b7fae6b9b366d2e..45763eed820a52d5a3e0d6326d8b26bf7d6fea2f 100644 (file)
@@ -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)
 ]
 
 
index dec9d898807c2b515f641d3fc38fa07ed7781bf8..3ef294adb57632ed3103389602651e9e69cd3148 100644 (file)
@@ -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/release_notes_5.9.0>
    Release Notes 5.8.0 <release_notes/release_notes_5.8.0>
    Release Notes 5.7.0 <release_notes/release_notes_5.7.0>
    Release Notes 5.6.0 <release_notes/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 (file)
index 0000000..78437fd
--- /dev/null
@@ -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.
+
index cbd2b4a868f705a96b9008c60d2ddd1b1ba512c9..90a1624af0f9a0ddedd68866d21b082455f331fb 100644 (file)
Binary files a/pdf/salomeTools.pdf and b/pdf/salomeTools.pdf differ