Description
============
-The **clean** command
-TODO
-TODO
-.
-Depending on the selected options, the created archive includes sources and binaries
-of SALOME products and prerequisites.
+The **clean** command removes products in the *source, build, or install* directories of an application. Theses directories are usually named ``SOURCES, BUILD, INSTALL``.
-Utility *salomeTools* is also included in the archive.
+Use the options to define what directories you want to suppress and to set the list of products
-.. important::
- By default the package only includes the sources of the prerequisites and the products.
- To select a subset use the *--content* option.
-
Usage
-=====
-* Create a package for a product (example as *SALOME_xx*): ::
+=======
- sat package SALOME_xx
-
- This command will create an archive named ``SALOME_xx.tgz`` in the working directory (``$USER.workDir``).
- If the archive already exists an exception is thrown.
-
-* Create a package with a specific name: ::
+* Clean all previously created *build* and *install* directories (example application as *SALOME_xx*):
- sat package SALOME_xx --name YourSpecificName
+ .. code-block:: bash
-.. important::
- 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 (modules or prerequisites) are
- included in the package, the architecture (ex: MD10_64) will be appened to the name.
-
- Example: ::
+ # take care, is long time to restore, sometimes
+ sat clean SALOME-xx --build --install
- sat package <product>
- Creates <proudct>.tar.gz in $USER.workDir
-
- sat package <product> -b
- Creates <proudct>_<arch>.tar.gz in $USER.workDir
-
- sat package <product> -n myname
- Creates myname.tar.gz in $USER.workDir
-
- sat package <product> -n ~/myname -b
- Creates myname.tar.gz in the home directory
+* Clean previously created *build* and *install* directories, only for products with property *is_salome_module*:
-* Force the creation of the archive (if it already exists): ::
+ .. code-block:: bash
- sat package <product> --force
-
-* Include the binaries in the archive (modules and prerequisites): ::
-
- sat package <product> --binaries
-
- This command will create an archive named ``<product>_<arch>.tar.gz`` where <arch> is the architecture of the machine.
+ sat clean SALOME-xxx --build --install \
+ --properties is_salome_module:yes
-* Set content of the archive: ::
- # only the prerequisites
- sat package <product> --content ps,pb
- # only the modules sources
- sat package <product> --content ms
- # only the binaries
- sat package <product> --content mb,pb
+Availables options
+======================
+ * **--products** : Products to clean.
- Possible values for content option are:
- * ms: modules sources
- * mb: modules binaries
- * ps: prerequisites sources
- * pb: prerequisites binaries
+ * **--properties** :
- .. note:: this option is not compatible with the *--binaries* option.
+ | Filter the products by their properties.
+ | Syntax: *--properties <property>:<value>*
-* Include the modules and prerequisites of the base product: ::
+ * **--sources** : Clean the product source directories.
- sat package <product> --with_base
+ * **--build** : Clean the product build directories.
-* Simulate the creation of the package (only check for required components): ::
+ * **--install** : Clean the product install directories.
- sat package <product> --simulate
+ * **--generated** : Clean source, build and install directories for generated products.
-* Do not include sample modules (like HELLO): ::
+ * **--package** : Clean the application package directory.
- sat package <product> --no_sample
+ * **--all** : Clean the product source, build and install directories.
- Sample modules are identified by the ``$TOOLS.common.module_info.<module_name>.module_type`` parameter.
+ * **--sources_without_dev** :
- By default salomeTools creates a copy of the installer with the same name than
- the package. Use this option to not generate the installer.
+ | Do not clean the products in development mode,
+ | (they could have VCS_ commits pending).
-* Do not delete version control system informations from the configurations files of the embedded salomeTools: ::
- sat package <product> --with_vcs
- The version control systems (vcs) taken into account by this option are CVS, SVN and Git.
+Some useful configuration pathes
+=================================
-Configuration
-=============
No specific configuration.
