doc/src/commands/compile.rst

   1
   2 Command compile
   3 ****************
   4
   5 Description
   6 ===========
   7 The **compile** command allows compiling the products of a SALOME application.
   8
   9
  10 Usage
  11 =====
  12 * Compile a complete application: ::
  13
  14     sat compile <application>
  15
  16 * Compile only some products: ::
  17
  18     sat compile <application> --products <product1>,<product2> ...
  19
  20 * Use **sat -t** to duplicate the logs in the terminal (by default the log are stored and displayed with *sat log* command): ::
  21
  22     sat -t compile <application> --products <product1>
  23
  24 * Compile a module and its dependencies: ::
  25
  26     sat compile <application> --products med --with_fathers
  27
  28 * Compile a module and the modules depending on it (for example plugins): ::
  29
  30     sat compile <application> --products med --with_children
  31
  32 * Clean the build and install directories before starting compilation: ::
  33
  34     sat compile <application> --products GEOM  --clean_all
  35     Note: a warning will be shown if option --products is missing
  36     (as it will clean everything!)
  37
  38 * Clean only the install directories before starting compilation: ::
  39
  40     sat compile <application> --clean_install
  41
  42 * Add options for make: ::
  43
  44     sat compile <application> --products <product> --make_flags <flags>
  45
  46 * Use the --check option to execute the unit tests after compilation: ::
  47
  48     sat compile <application> --check
  49
  50 * Remove the build directory after successful compilation (some build directory like qt are big!): ::
  51
  52     sat compile <application> --products qt --clean_build_after
  53
  54 * Stop the compilation as soon as a the compilation of a module fails: ::
  55
  56     sat compile <product> --stop_first_fail
  57
  58 * Do not compile! just show if products are installed or not, and where is the installation: ::
  59
  60     sat compile <application> --show
  61
  62
  63 Configuration
  64 =============
  65 The way to compile a product is defined in the product configuration file (pyconf).
  66 The main options are:
  67
  68   * **build_source** : the method used to build the product (cmake/autotools/script)
  69   * **compil_script** : the compilation script if build_source is equal to "script"
  70   * **cmake_options** : additional options for cmake.
  71   * **nb_proc** : number of jobs to use with make for this product.