doc/src/commands/init.rst

   1 .. include:: ../../rst_prolog.rst
   2
   3 Command config
   4 ******************
   5
   6 Description
   7 ===========
   8 The **init** command manages the sat local configuration (which is stored in the data/local.pyconf file).
   9 It allows to initialise the content of this file.
  10
  11 Usage
  12 =====
  13 * A sat project provides all the pyconf files relatives to a project (salome for example). Use the *--add_project* command to add a sat project locally, in data/local.pyconf (by default sat comes without any project). It is possible to add  as many projects as required. ::
  14
  15     sat init --add_project <path/to/a/sat/project/project.pyconf>
  16
  17
  18 * If you need to remove a sat project from the local configuration, use the *--reset_projects* command to remove all projects and then add the nex ones with *--add_project*: ::
  19
  20     sat init --reset_projects
  21     sat init --add_project <path/to/a/new/sat/project/project.pyconf>
  22
  23 * By default the product archives are stored locally within the directory containing salomeTool, in a subdirectory called ARCHIVES. If you want to change the default, use the *--archive_dir* option: ::
  24
  25     sat init --archive_dir  <local/path/where/to/store/product/archives>
  26
  27 * sat enable a **base** mode, which allow to mutualize product builds between several applications. By defaut, the mutualised builds are stored locally within the directory containing salomeTool, in a subdirectory called  BASE. To change the default, use the *--base* option: ::
  28
  29     sat init --base <local/path/where/to/store/product/mutualised/product/builds>
  30
  31 * In the same way, you can use the *--workdir* and *--log_dir* commands to change the default directories used to store the application builds, and sat logs: ::
  32
  33     sat init --workdir <local/path/where/to/store/applications>
  34     sat init --log_dir <local/path/where/to/store/sat/logs>
  35
  36
  37
  38 Some useful configuration pathes
  39 =================================
  40
  41 All the sat init commands update the local pyconf salomeTool file data/local.pyconf. The same result can be achieved by editing the file directly.
  42 The content of data/local.pyconf is dumped into two sat configuration variables:
  43
  44 * **LOCAL**: Contains notably all the default paths in the fields archive_dir, base, log_dir and workdir.
  45
  46 * **PROJECTS**: The field project_file_paths contains all the project files that have been included with --add_project option.
  47
  48 sat commands: ::
  49
  50   sat config -v LOCAL
  51   sat config -v PROJECTS
  52
  53
  54