doc/src/release_notes/release_notes_5.5.0.rst

   1 *****************
   2 SAT version 5.5.0
   3 *****************
   4
   5 Release Notes, November 2019
   6 ============================
   7
   8 .. warning:: This documentation is under construction!
   9
  10 New features and improvments
  11 ----------------------------
  12
  13
  14
  15 **pip mode for python modules**
  16
  17 This new mode was introduced in order to simplify the management of the python products (which number is constantly raising years after years...)
  18 It is trigered by two properties within the application configuration file::
  19
  20     pip : 'yes'
  21     pip_install_dir : 'python'
  22
  23 The first property activates the use of pip for all the products which have themselves the pip property activated (it concerns twenty products).
  24 The second property specifies that the products should be installed directly in python directory, and not in their own specific directory.
  25 This second property is usefull on windows platform to reduce the length of python path.
  26
  27 After several tests anf iterations, the following management was adopted:
  28  - sat prepare <application> does nothing for pip products (because at prepare time we don't have python compiled, and the use of native pip may not be compatible).
  29  - sat compile <application> use the pip module installed in python to get pip archives (wheels), store them in local archive directory, and install then either in python
  30 directory, or in the product directory (in accordance to pip_install_dir property).
  31
  32
  33 **single directory mode**
  34
  35 This new mode was introduced in order to get shorter path on windows platform. It is trigered by the property **single_install_dir**  within the application configuration file::
  36
  37         single_install_dir : "yes"
  38
  39 When activated, all the products which have themselves the property **single_install_dir** are installed in a common directory, called PRODUCTS.
  40
  41 **Generalisation of sat launcher command**
  42
  43 sat launcher command was extended to generate lauchers based on an executable given as argument with **-e** option::
  44
  45     sat launcher <application> -n salome.sh -e INSTALL/SALOME/bin/salome.py
  46
  47 The command generates a launcher called salome.sh, which set the environment, and launch the INSTALL/SALOME/bin/salome.py.
  48
  49
  50 **optimisation of sat compile**
  51
  52 For a complete compilation of salome, sat compile command was spending more than three minutes
  53 to calculate the dependencies and the order in which the products shoulb be compiled.
  54 The algorithm used was clumsy, and confused.
  55 It was therefore completely rewritten using a topological sorting.
  56 The products order calculation take now less than one second.
  57
  58 **new management of sections in product configution files**
  59
  60 The sections defined in products are used to specify the variations in the way products are built.
  61 Depending upon the tag or version of the product, sat choose one of these sections and set the product definition according to it.
  62 With time, the number of sections increased a lot. And it is not easy to visualise the differences between these sections, as they often
  63 are identical, except few variations.
  64 With the windows version, new sections are introduced to manage windows specifics.
  65
  66 Therefore the need of a new mode for managing sections arises, that would be simplier, more concise, and help the comprehension.
  67 This new mode is called **incremental**, and is trigered by the property **incremental** within the default section of the product::
  68
  69     default:
  70     {
  71         ....
  72         properties:
  73         {
  74             incremental : "yes"
  75         }
  76         ...
  77     }
  78
  79 When this mode is defined, the definition of the product is defined incrementaly, by taking into account the reference (the default section) and applying to it corrections defined in the other incremental sections. Depending upon the case several sections may be taken into account, in a predefined order:
  80
  81 * the default section, which contains the reference definition
  82 * on windows platform, the default_win section if it exists
  83 * the section corresponding to the tag. the algorithm to determine this section remains unchanged (what changes is that in incremental mode the section only define deltas, not the complete definition)
  84 * on windows platform, if it exists the same section posfiwed with "_win".
  85
  86 Here is as an example the incremental definition used for boost products. For version 1.49 of boost, we extend the definition because we need to apply a patch::
  87
  88     default :
  89     {
  90         name : "boost"
  91         build_source : "script"
  92         compil_script :  $name + $VARS.scriptExtension
  93         get_source : "archive"
  94         environ :
  95         {
  96            env_script : $name + ".py"
  97         }
  98         depend : ['Python' ]
  99         opt_depend : ['openmpi' ]
 100         patches : [ ]
 101         source_dir : $APPLICATION.workdir + $VARS.sep + 'SOURCES' + $VARS.sep + $name
 102         build_dir : $APPLICATION.workdir + $VARS.sep + 'BUILD' + $VARS.sep + $name
 103         install_dir : 'base'
 104         properties :
 105         {
 106             single_install_dir : "yes"
 107             incremental : "yes"
 108         }
 109     }
 110
 111     version_1_49_0:
 112     {
 113         patches : [ "boost-1.49.0.patch" ]
 114     }
 115
 116 ** Suppression of the global "no_base" flag in application configuration**
 117
 118 **no_base : "no"** is not interpreted anymore in application pyconf.
 119 One has to use the **base** flag.
 120 The possible values are:
 121
 122 * **yes** : all the products go into the base
 123 * **no** : no product goes into the base
 124
 125 The complete usage rule of bases is explaned in the documentation.
 126
 127
 128 Change log
 129 ----------
 130
 131 This chapter does not provide the complete set of changes included, only the
 132 most significant changes are listed.
 133
 134
 135 +-------------+-----------------------------------------------------------------------------------+
 136 | Artifact    | Description                                                                       |
 137 +=============+===================================================================================+
 138 | spns #8544  | The documentation has been improved!                                              |
 139 +-------------+-----------------------------------------------------------------------------------+
 140 | spns #16894 | clean the temp directory at the end of sat package                                |
 141 +-------------+-----------------------------------------------------------------------------------+
 142 | sat #12965  | optimisation of sat compile : better, simplier and faster algo for dependencies!  |
 143 +-------------+-----------------------------------------------------------------------------------+
 144 | sat # 17206 | Use pip to manage python modules                                                  |
 145 +-------------+-----------------------------------------------------------------------------------+
 146 | sat #17137  | check_install functionality improvement : uses linux expending shell rules and    |
 147 |             | interprets environment variables                                                  |
 148 +-------------+-----------------------------------------------------------------------------------+
 149 | sat #8544   | Update and improvement of documentation                                           |
 150 +-------------+-----------------------------------------------------------------------------------+
 151 | sat # 8547  | Generalisation of sat launcher command (new option --exe to specify which exe     |
 152 |             | should be launched after setting the environment                                  |
 153 +-------------+-----------------------------------------------------------------------------------+
 154 | sat #17357  | New field "rm_products" to blacklist products in overwrite section of appli pyconf|
 155 +-------------+-----------------------------------------------------------------------------------+
 156 | sat #17194  | Parametrication of the value of INSTALL and BINARIES directories                  |
 157 |             | (in src/internal_config/salomeTools.pyconf)                                       |
 158 +-------------+-----------------------------------------------------------------------------------+
 159 | sat #17639  | Warning when sat is launcher with python3                                         |
 160 +-------------+-----------------------------------------------------------------------------------+
 161 | sat #17359  | New incremental mode for the definition of products                               |
 162 +-------------+-----------------------------------------------------------------------------------+
 163 | sat #17766  | The environment of products is now  loaded in the order of product dependencies.  |
 164 | sat #17848  | To treat correctly dependencies in the environment                                |
 165 +-------------+-----------------------------------------------------------------------------------+
 166 | sat #17955  | No unit tests for native products                                                 |
 167 +-------------+-----------------------------------------------------------------------------------+
 168 |             | SAT_DEBUG and SAT_VERBOSE environment variables are now available in the          |
 169 |             | compilation, which can now forward the information and do the job!                |
 170 +-------------+-----------------------------------------------------------------------------------+