doc/src/release_notes/release_notes_5.3.0.rst

   1 *****************
   2 SAT version 5.3.0
   3 *****************
   4
   5 Release Notes, February, 2019
   6 =============================
   7
   8 New features and improvments
   9 ----------------------------
  10
  11 **sat init**
  12
  13 The command *sat init* has been finalized, with the addition of options **--add_project** and **--reset_projects**.
  14 It is now able to manage projects after an initial git clone of sat. The capacity is used by users
  15 installing sat from the git repositories:
  16
  17 .. code-block:: bash
  18
  19     # get sources of sat
  20     git clone https://codev-tuleap.cea.fr/plugins/git/spns/SAT.git sat
  21
  22     # get SAT_SALOME project (the sat project that contains the configuration of SALOME)
  23     git clone https://codev-tuleap.cea.fr/plugins/git/spns/SAT_SALOME.git
  24
  25     # initialise sat with this project
  26     sat init --add_project $(pwd)/SAT_SALOME/salome.pyconf
  27
  28 It is possible to initialise sat with several projects by calling several times *sat init --add_project*
  29
  30 **sat prepare : git retry functionality**
  31
  32 With large git repositories (>1GB) *git clone* command may fail. To decrease the risk, sat prepare will now retry
  33 three times the *git clone* function in case of failure.
  34
  35 **Reset of LD_LIBRARY_PATH and PYTHONPATH  before setting the environment**
  36
  37 Every year, a lot of problems occur, due to users (bad) environment. This is most of the time caused
  38 by the presence (out-of-date) .bashrc files.
  39 To prevent these (time-consuming) problems, sat now reset LD_LIBRARY_PATH and PYTHONPATH variables
  40 before setting the environment thus avoiding side effects.
  41 Users who wish anayway to start SALOME with a non empty LD_LIBRARY_PATH or PYTHONPATH may comment
  42 the reset in salome launcher or in env_launch.sh file.
  43
  44 **New option --complete for sat prepare**
  45
  46 This option is used when an installation is interrupted or incomplete. It allows downloading only
  47 the sources of missing products
  48
  49 .. code-block:: bash
  50
  51     # only get sources of missing products (i.e products not present in INSTALL dir)
  52     git prepare SALOME-master -c
  53
  54 ** New option --packages for sat clean**
  55
  56 SALOME packages are big... It is usefull to be able to clean them whith this new option.
  57
  58 .. code-block:: bash
  59
  60     # remove packages present in PACKAGES directory of SALOME-master
  61     git clean SALOME-master --packages
  62
  63 **Global configuration keys "debug", "verbose" and "dev" in applications**
  64
  65
  66 These new keys can be defined in applications in order to trigger the debug, verbose and dev mode for all products.
  67 In the following example, the SALOME-master application will be compiled in debug mode (use of **-g** flag), but with no verbosity.
  68 Its products are not in development mode.
  69
  70 .. code-block:: bash
  71
  72     APPLICATION :
  73     {
  74         name : 'SALOME-master'
  75         workdir : $LOCAL.workdir + $VARS.sep + $APPLICATION.name + '-' + $VARS.dist
  76         tag : 'master'
  77         dev : 'no'
  78         verbose :'no'
  79         debug : 'yes'
  80         ...
  81     }
  82
  83 Change log
  84 ----------
  85
  86 This chapter does not provide the complete set of changes included, only the
  87 most significant changes are listed.
  88
  89
  90 +------------+-----------------------------------------------------------------------------------+
  91 | Artifact   | Description                                                                       |
  92 +============+===================================================================================+
  93 | sat #16548 | Finalisation of sat init command (options -add_project and --reset_projects)      |
  94 | sat #8566  |                                                                                   |
  95 +------------+-----------------------------------------------------------------------------------+
  96 | sat #12994 | new git retry functionality for sat prepare : give three trials in case of        |
  97 |            | failures                                                                          |
  98 +------------+-----------------------------------------------------------------------------------+
  99 | sat #8581  | traceability : save tag of sat and its projects                                   |
 100 +------------+-----------------------------------------------------------------------------------+
 101 | sat #8588  | reset LD_LIBRARY_PATH and PYTHONPATH before launching SALOME                      |
 102 +------------+-----------------------------------------------------------------------------------+
 103 | sat #9575  | Improvement of the DISTENE licences management (notably for packages)             |
 104 +------------+-----------------------------------------------------------------------------------+
 105 | sat #8597  | Implementation of option sat prepare -c (--complete) for preparing only the       |
 106 |            | sources that are not yet installed                                                |
 107 +------------+-----------------------------------------------------------------------------------+
 108 | sat #8655  | implementation of option sat clean --packages                                     |
 109 +------------+-----------------------------------------------------------------------------------+
 110 | sat #8532  | sat log : rename option --last_terminal in --last_compile                         |
 111 | sat #8594  | Extension of sat log --last_compile to the logs of make check                     |
 112 +------------+-----------------------------------------------------------------------------------+
 113 | sat #13271 | hpc mode triggered by product "hpc" key in state of MPI_ROOT variable             |
 114 |            |                                                                                   |
 115 +------------+-----------------------------------------------------------------------------------+
 116 | sat #8606  | sat generate clean old directories before a new generation                        |
 117 +------------+-----------------------------------------------------------------------------------+
 118 | sat #12952 | Add global keys "debug", "verbose" and "dev" to manage globally these modes       |
 119 |            | for all the products of an application                                            |
 120 +------------+-----------------------------------------------------------------------------------+
 121 | sat #8523  | protection of call to ssh on windows platform                                     |
 122 +------------+-----------------------------------------------------------------------------------+