From 8a8128f7f9cb31aa5e2ce2236c24a97696d60a35 Mon Sep 17 00:00:00 2001
From: crouzet <nicolas.crouzet@cea.fr>
Date: Fri, 1 Dec 2017 16:41:05 +0100
Subject: [PATCH] add compile command

---
 doc/src/commands/compile.rst | 70 ++++++++++++++++++++++++++++++++++++
 doc/src/index.rst            |  1 +
 2 files changed, 71 insertions(+)
 create mode 100644 doc/src/commands/compile.rst

diff --git a/doc/src/commands/compile.rst b/doc/src/commands/compile.rst
new file mode 100644
index 0000000..6c06143
--- /dev/null
+++ b/doc/src/commands/compile.rst
@@ -0,0 +1,70 @@
+*******
+compile
+*******
+
+Description
+===========
+The **compile** command allows compiling the products of a SALOME application.
+
+
+Usage
+=====
+* Compile a complete application: ::
+
+    sat compile <application>
+
+* Compile only some products: ::
+
+    sat compile <application> --products <product1>,<product2> ... 
+
+* Use **sat -t** to duplicate the logs in the terminal (by default the log are stored and displayed with *sat log* command): ::
+
+    sat -t compile <application> --products <product1>
+
+* Compile a module and its dependencies: ::
+
+    sat compile <application> --products med --with_fathers
+
+* Compile a module and the modules depending on it (for example plugins): ::
+  
+    sat compile <application> --products med --with_children
+
+* Clean the build and install directories before starting compilation: ::
+
+    sat compile <application> --products GEOM  --clean_all
+    Note: a warning will be shown if option --products is missing (as it will clean everything!)
+
+* Clean only the install directories before starting compilation: ::
+
+    sat compile <application> --clean_install
+
+* Add options for make: ::
+
+    sat compile <application> --products <product> --make_flags <flags>
+
+* Use the --check option to execute the unit tests after compilation: ::
+
+    sat compile <application> --check
+
+* Remove the build directory after successful compilation (some build directory like qt are big!): ::
+
+    sat compile <application> --products qt --clean_build_after
+
+* Stop the compilation as soon as a the compilation of a module fails: ::
+  
+    sat compile <product> --stop_first_fail
+
+* Do not compile! just show if products are installed or not, and where is the installation: ::
+
+    sat compile <application> --show
+
+
+Configuration
+=============
+The way to compile a product is defined in the product configuration file (pyconf).
+The main options are: 
+
+  * **build_source** : the method used to build the product (cmake/autotools/script)
+  * **compil_script** : the compilation script if build_source is equal to "script"
+  * **cmake_options** : additional options for cmake.
+  * **nb_proc** : number of jobs to use with make for this product.
diff --git a/doc/src/index.rst b/doc/src/index.rst
index 802b7b7..9ac0362 100644
--- a/doc/src/index.rst
+++ b/doc/src/index.rst
@@ -28,6 +28,7 @@ List of Commands
    
    config <commands/config>
    prepare <commands/prepare>
+   compile <commands/compile>
    log <commands/log>
 
 Code documentation
-- 
2.39.2