From 7dfc60e95e3b1879c0814199a08aa1aed8dca152 Mon Sep 17 00:00:00 2001 From: Christian Van Wambeke Date: Tue, 24 Apr 2018 13:21:06 +0200 Subject: [PATCH] minor change in doc --- doc/src/commands/clean.rst | 26 ++++++++++++---------- doc/src/commands/package.rst | 10 +++++---- doc/src/configuration.rst | 42 ++++++++++++++++++++++++++---------- 3 files changed, 52 insertions(+), 26 deletions(-) diff --git a/doc/src/commands/clean.rst b/doc/src/commands/clean.rst index 8ec9b9f..e5d2f38 100644 --- a/doc/src/commands/clean.rst +++ b/doc/src/commands/clean.rst @@ -15,12 +15,16 @@ Use the options to define what directories you want to suppress and to set the l Usage ======= -* Clean all previously created *build* and *install* directories (example application as *SALOME_xx*): :: +* Clean all previously created *build* and *install* directories (example application as *SALOME_xx*): + + .. code-block:: bash # take care, is long time to restore, sometimes sat clean SALOME-xx --build --install -* Clean previously created *build* and *install* directories, only for products with property *is_salome_module*: :: +* Clean previously created *build* and *install* directories, only for products with property *is_salome_module*: + + .. code-block:: bash sat clean SALOME-xxx --build --install \ --properties is_salome_module:yes @@ -29,24 +33,24 @@ Usage Availables options ====================== - * **--products**: Products to clean. + * **--products** : Products to clean. - * **--properties**: + * **--properties** : | Filter the products by their properties. - | Syntax: --properties : + | Syntax: *--properties :* - * **--sources**: Clean the product source directories. + * **--sources** : Clean the product source directories. - * **--build**: Clean the product build directories. + * **--build** : Clean the product build directories. - * **--install**: Clean the product install directories. + * **--install** : Clean the product install directories. - * **--all**: Clean the product source, build and install directories. + * **--all** : Clean the product source, build and install directories. - * **--sources_without_dev**: + * **--sources_without_dev** : - | Do not clean the products in development mode, + | Do not clean the products in development mode, | (they could have VCS_ commits pending). diff --git a/doc/src/commands/package.rst b/doc/src/commands/package.rst index dee6863..6d6648a 100644 --- a/doc/src/commands/package.rst +++ b/doc/src/commands/package.rst @@ -36,10 +36,12 @@ Usage .. note:: By default, the archive is created in the working directory of the user (``USER.workDir``). - If the option *name* is used with a path (relative or absolute) it will be used. - If the option *name* is not used and binaries (prerequisites and products) are - included in the package, the OS_ architecture - will be appended to the name (example: *SALOME_xx-CO7.tgz*). + + If the option *--name* is used with a path (relative or absolute) it will be used. + + If the option *--name* is not used and binaries (prerequisites and products) + are included in the package, the OS_ architecture + will be appended to the name (example: ``SALOME_xx-CO7.tgz``). Examples: :: diff --git a/doc/src/configuration.rst b/doc/src/configuration.rst index b126c3b..7f415a3 100644 --- a/doc/src/configuration.rst +++ b/doc/src/configuration.rst @@ -20,7 +20,7 @@ The configuration files use a python-like structure format * **$prefix** reference to another parameter (ex: ``$PRODUCT.name``), * **#** comments. -.. note:: in this documentation a reference to a configuration parameter will be noted ``$XXX.YYY``. +.. note:: in this documentation a reference to a configuration parameter will be noted ``XXX.YYY``. Description =========== @@ -30,38 +30,58 @@ Description VARS section ------------- | This section is dynamically created by salomeTools at run time. -| It contains information about the environment: date, time, OS, architecture etc. +| It contains information about the environment: date, time, OS, architecture etc. -.. note:: use this command to get the current setting: *sat config -v VARS* +:: + # to get the current setting + sat config --value VARS PRODUCTS section ------------------ | This section is defined in the product file. | It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions) -.. note:: use this command to get the current setting: *sat config SALOME-xx -v PRODUCTS* +:: + + # to get the current setting + sat config SALOME-xx --value PRODUCTS APPLICATION section --------------------- | This section is optional, it is also defined in the product file. | It gives additional parameters to create an application based on SALOME, as versions of products to use. -.. note:: use this command to get the current setting: *sat config SALOME-xx -v APPLICATION* +:: + + # to get the current setting + sat config SALOME-xx --value APPLICATION + .. _USER-Section: USER section -------------- -This section is defined by the user configuration file -which is located in *~/.salomeTools/salomeTools.pyconf*. +This section is defined by the user configuration file, +``~/.salomeTools/salomeTools.pyconf``. + +The ``USER`` section defines some parameters (not exhaustive): + +* **workDir** : + + | The working directory. + | Each product will be usually installed here (in sub-directories). + +* **browser** : The web browser to use (*firefox*). + +* **editor** : The editor to use (*vi, pluma*). -The USER section defines parameters (not exhaustive): +* and other user preferences. -* **workDir** the working directory. Each product will be usually installed here (in sub-directories). -* and other users preferences. +:: -.. note:: use this command to get the current setting: *sat config SALOME-xx -v USER*. + # to get the current setting + sat config SALOME-xx --value USER -- 2.39.2