Changeset 11723 for utils

Timestamp:

2019-10-18T14:33:36+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Review of INSTALL.rst

File:

• utils/build/makenemo (modified) (4 diffs)

utils/build/makenemo

@@ -52 +52 @@
 # - TOOLS_DIR   :   "    "    "
 # - NEMO_DIR    :   "    "    "
-# - REMOTE_CTL  : URL link to a remote resource list for an external configuration 
+# - REMOTE_CTL  : URL link to a remote resource list for an external configuration
 #                 which is not part of the reference suite
-# - LOCAL_REF   : Nearest reference configuration to an external configuration 
+# - LOCAL_REF   : Nearest reference configuration to an external configuration
 #                 which is not part of the reference suite
 #                 (used to populate work directories if remote access is not available)
@@ -119 +119 @@
 Usage:
 ------
-./makenemo -[aru] CONFIG -m ARCH [-[dehjntv] ...] [{list_key,clean,clean_config}] [{add_key,del_key} ...]
-
-Mandatory:
-   -m   Computing architecture (./arch), FCM file describing the compilation settings
+./makenemo -[aru] CONFIG -m ARCH [-[dehjntv] ...] [{list_key,clean,clean_config}]
+                                                  [{add_key,del_key} ...]
+
+Mandatory
+   -m    Computing architecture (./arch), FCM file describing the compilation settings
+
    and one of the following option (use 'all' arg to list available items)
-   -r   Reference configuration (./cfgs), proven with long-term support until the EOL of the release
-   -a   Academic test case (./tests), ready to use at the release start without guarantee or support over time
-   -u   Scripted remote configuration (see ./tests/rmt_cfgs.txt)
-
-Optional:
-   -d   New set of sub-components (list from ./src directory)
-   -e   Path for alter patch  location (default: 'MY_SRC' in configuration folder)
-   -h   Print this help
-   -j   Number of processes to compile (0: dry run with no build)
-   -n   Name for new configuration
-   -s   Path for alter source location (default: 'src' root directory)
-   -t   Path for alter build  location (default: 'BLD' in configuration folder)
-   -v   Level of verbosity ([0-3])
-
-Examples:
+
+   -r    Reference configuration (./cfgs), proven with long-term support
+   -a    Academic test case (./tests), ready-to-use configuration with no support over time
+   -u    Scripted remote configuration (see ./tests/rmt_cfgs.txt)
+
+Optional
+   -d    New set of sub-components (subfolders from ./src directory)
+   -e    Path for alter patch  location (default: 'MY_SRC' in configuration folder)
+   -h    Print this help
+   -j    Number of processes to compile (0: dry run with no build)
+   -n    Name for new configuration
+   -s    Path for alter source location (default: 'src' root directory)
+   -t    Path for alter build  location (default: 'BLD' in configuration folder)
+   -v    Level of verbosity ([0-3])
+
+Examples
    ¤ Configuration creation
-        Build          : ./makenemo -[aru] ... [...]
+        Build          : ./makenemo         -[aru] ... [...]
         Copy           : ./makenemo -n ...  -[aru] ... [...]
    ¤ Configuration management
-        List CPP keys  : ./makenemo [...] list_key
-        Add-Remove keys: ./makenemo [...] add_key '...' del_key '...'
-        Fresh start    : ./makenemo [...] clean
-        Erasure        : ./makenemo [...] clean_config
+        List CPP keys  : ./makenemo -n ... list_key
+        Add-Remove keys: ./makenemo -n ... add_key '...' del_key '...'
+        Fresh start    : ./makenemo -n ... clean
+        Removal        : ./makenemo -n ... clean_config
 EOF
             exit 0       ;;
@@ -258 +261 @@
 else
 
-   ## Reuse a working cfg  
+   ## Reuse a working cfg
    if [[ -f ${CONFIG_DIR}/work_cfgs.txt && $( grep "${TML_CONF} " ${CONFIG_DIR}/work_cfgs.txt ) ]]; then
       conf_file=work_cfgs.txt
@@ -362 +365 @@
 
    ## if AGRIF we do a first preprocessing
-   if [[ ${#x_c} -eq 0 && "$AGRIFUSE" -eq 1 ]]; then 
+   if [[ ${#x_c} -eq 0 && "$AGRIFUSE" -eq 1 ]]; then
       fcm build --ignore-lock -j 1 ${COMPIL_DIR}/bld_preproagr.cfg ||{ cd - ; exit 1 ;}
       echo ''