doc/src/commands/clean.rst

   1
   2 .. include:: ../../rst_prolog.rst
   3
   4 Command clean
   5 ****************
   6
   7 Description
   8 ============
   9
  10 The **clean** command removes products in the SOURCES, BUILD, or INSTALL directories of an application.
  11
  12 Use the options to define what directories you want to suppress and to set the list of products
  13
  14
  15 Usage
  16 =======
  17
  18 * Clean all previously created *build* and *install* directories (example application as *SALOME_xx*): ::
  19
  20     # take care, is long time to restore, sometimes
  21     sat clean SALOME-xx --build --install
  22
  23 * Clean previously created *build* and *install* directories, only for products with property *is_salome_module*: ::
  24
  25     sat clean SALOME-xxx --build --install \
  26                          --properties is_salome_module:yes
  27
  28
  29 Availables options
  30 ======================
  31
  32   * **--products**: Products to clean.
  33
  34   * **--properties**:
  35
  36     | Filter the products by their properties.
  37     | Syntax: --properties <property>:<value>
  38
  39   * **--sources**: Clean the product source directories.
  40
  41   * **--build**: Clean the product build directories.
  42
  43   * **--install**: Clean the product install directories.
  44
  45   * **--all**: Clean the product source, build and install directories.
  46
  47   * **--sources_without_dev**:
  48
  49     | Do not clean the products in development mode.
  50     | have they VCS_ commits pending?
  51
  52
  53
  54 Some useful configuration pathes
  55 =================================
  56
  57 No specific configuration.