]> SALOME platform Git repositories - tools/sat.git/commitdiff
Salome HOME
documentation, option de sat package --with_vcs en combinaison avec --bin_products
authorcrouzet <nicolas.crouzet@cea.fr>
Fri, 7 Jan 2022 13:47:33 +0000 (14:47 +0100)
committercrouzet <nicolas.crouzet@cea.fr>
Fri, 7 Jan 2022 13:47:33 +0000 (14:47 +0100)
commands/package.py
doc/README
doc/src/commands/install.rst [new file with mode: 0644]
doc/src/commands/package.rst
doc/src/index.rst

index c4fb43770436ea51804efabf32c0a205a43d30c4..bbb20bed7f62b1bbd22c5b62f9d4f5d9deb14ee2 100644 (file)
@@ -121,7 +121,8 @@ parser.add_option('', 'bin_products', 'boolean', 'bin_products',
     _('Optional: Create binary archives for all products.'), False)
 parser.add_option('', 'with_vcs', 'boolean', 'with_vcs',
     _('Optional: Do not make archive for products in VCS mode (git, cvs, svn). ' 
-      'Sat prepare will use VCS mode instead to retrieve them'),
+      'Sat prepare will use VCS mode instead to retrieve them.'
+      '\n          Also, when combined with "--bin_products" option, restrict the building of product archives to VCS products.'),
     False)
 parser.add_option('', 'ftp', 'boolean', 'ftp',
     _('Optional: Do not embed archives for products in archive mode.' 
index b412c82e75a6da6adf5b04d2d2186d99f7780e94..4c17041916c4825ddf06c21cad073dbbc005fcf7 100644 (file)
@@ -32,5 +32,5 @@ firefox build/html/index.html &
 # make doc pdf
 cd doc
 make latexpdf
-evince build/latex/salomeTools.pdf &
+evince build/latex/sat.pdf &
 
diff --git a/doc/src/commands/install.rst b/doc/src/commands/install.rst
new file mode 100644 (file)
index 0000000..b493114
--- /dev/null
@@ -0,0 +1,16 @@
+
+.. include:: ../../rst_prolog.rst
+
+Command install
+***************
+
+Description
+===========
+The **install** command gets the binaries of the application products from local (ARCHIVEPATH) or ftp server.
+
+
+Usage
+=====
+* Create a binary installation of SALOME which only contains SALOME,GEOM and SMESH modules, plus their dependencies: ::
+
+    sat install SALOME-master --products SALOME,GEOM,SMESH
index f2ec862990c78637dfd8c4c84104ae5d5c414c8d..8e6680b9c73ea5fc79ab2299eca8a340399c5591 100644 (file)
@@ -74,6 +74,13 @@ Usage
 
   The version control systems known by this option are CVS_, SVN_ and Git_.
 
+* Create binary archives for each product: ::
+
+    # Create binary product archives for all products
+    sat package SALOME_xx --bin_products
+
+    # Create binary product archives only for VCS products
+    sat package SALOME_xx --bin_products --with_vcs
 
 Some useful configuration paths
 =================================
index eeaef73d862527aaed9d3344a0c9a688aa056dba..dec9d898807c2b515f641d3fc38fa07ed7781bf8 100644 (file)
@@ -66,6 +66,7 @@ List of Commands
    init <commands/init>
    template <commands/template>
    application <commands/application>
+   install <commands/install>
 
 
 Release Notes