doc/build/html/_sources/commands/clean.txt

   1
   2 .. include:: ../../rst_prolog.rst
   3
   4 Command clean
   5 ****************
   6
   7 Description
   8 ============
   9
  10 The **clean** command removes products in the *source, build, or install* directories of an application. Theses directories are usually named ``SOURCES, BUILD, INSTALL``.
  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   .. code-block:: bash
  21
  22     # take care, is long time to restore, sometimes
  23     sat clean SALOME-xx --build --install
  24
  25 * Clean previously created *build* and *install* directories, only for products with property *is_salome_module*:
  26
  27   .. code-block:: bash
  28
  29     sat clean SALOME-xxx --build --install \
  30                          --properties is_salome_module:yes
  31
  32
  33 Availables options
  34 ======================
  35
  36   * **--products** : Products to clean.
  37
  38   * **--properties** :
  39
  40     | Filter the products by their properties.
  41     | Syntax: *--properties <property>:<value>*
  42
  43   * **--sources** : Clean the product source directories.
  44
  45   * **--build** : Clean the product build directories.
  46
  47   * **--install** : Clean the product install directories.
  48
  49   * **--all** : Clean the product source, build and install directories.
  50
  51   * **--sources_without_dev** :
  52
  53     | Do not clean the products in development mode,
  54     | (they could have VCS_ commits pending).
  55
  56
  57
  58 Some useful configuration pathes
  59 =================================
  60
  61 No specific configuration.