doc/src/commands/clean.rst

   1
   2 .. include:: ../../rst_prolog.rst
   3
   4 Command clean
   5 ****************
   6
   7 Description
   8 ============
   9 The **clean** command
  10 TODO
  11 TODO
  12 .
  13
  14 Depending on the selected options, the created archive includes sources and binaries
  15 of SALOME products and prerequisites.
  16
  17 Utility *salomeTools* is also included in the archive.
  18
  19 .. important::
  20     By default the package only includes the sources of the prerequisites and the products.
  21     To select a subset use the *--content* option.
  22
  23
  24 Usage
  25 =====
  26 * Create a package for a product (example as *SALOME_xx*): ::
  27
  28     sat package SALOME_xx
  29
  30   This command will create an archive named ``SALOME_xx.tgz`` in the working directory (``$USER.workDir``).
  31   If the archive already exists an exception is thrown.
  32
  33 * Create a package with a specific name: ::
  34
  35     sat package SALOME_xx --name YourSpecificName
  36
  37 .. important::
  38     By default, the archive is created in the working directory of the user (``$USER.workDir``).
  39     If the option *name* is used with a path (relative or absolute) it will be used.
  40     If the option *name* is not used and binaries (modules or prerequisites) are
  41     included in the package, the architecture (ex: MD10_64) will be appened to the name.
  42
  43     Example: ::
  44
  45         sat package <product>
  46         Creates <proudct>.tar.gz in $USER.workDir
  47
  48         sat package <product> -b
  49         Creates <proudct>_<arch>.tar.gz in $USER.workDir
  50
  51         sat package <product> -n myname
  52         Creates myname.tar.gz in $USER.workDir
  53
  54         sat package <product> -n ~/myname -b
  55         Creates myname.tar.gz in the home directory
  56
  57 * Force the creation of the archive (if it already exists): ::
  58
  59     sat package <product> --force
  60
  61 * Include the binaries in the archive (modules and prerequisites): ::
  62
  63     sat package <product> --binaries
  64
  65   This command will create an archive named ``<product>_<arch>.tar.gz`` where <arch> is the architecture of the machine.
  66
  67 * Set content of the archive: ::
  68
  69     # only the prerequisites
  70     sat package <product> --content ps,pb
  71     # only the modules sources
  72     sat package <product> --content ms
  73     # only the binaries
  74     sat package <product> --content mb,pb
  75
  76
  77   Possible values for content option are:
  78     * ms: modules sources
  79     * mb: modules binaries
  80     * ps: prerequisites sources
  81     * pb: prerequisites binaries
  82
  83   .. note:: this option is not compatible with the *--binaries* option.
  84
  85 * Include the modules and prerequisites of the base product: ::
  86
  87     sat package <product> --with_base
  88
  89 * Simulate the creation of the package (only check for required components): ::
  90
  91     sat package <product> --simulate
  92
  93 * Do not include sample modules (like HELLO): ::
  94
  95     sat package <product> --no_sample
  96
  97   Sample modules are identified by the ``$TOOLS.common.module_info.<module_name>.module_type`` parameter.
  98
  99   By default salomeTools creates a copy of the installer with the same name than
 100   the package. Use this option to not generate the installer.
 101
 102 * Do not delete version control system informations from the configurations files of the embedded salomeTools: ::
 103
 104     sat package <product> --with_vcs
 105
 106   The version control systems (vcs) taken into account by this option are CVS, SVN and Git.
 107
 108 Configuration
 109 =============
 110 No specific configuration.