documentation for wololo

MetPX · May 17, 2024 · beacf57 · beacf57
1 parent 7612427
commit beacf57
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 4 deletions.
diff --git a/docs/source/Explanation/CommandLineGuide.rst b/docs/source/Explanation/CommandLineGuide.rst
@@ -70,7 +70,7 @@ the broker, or manage the configurations.
  - remove:        remove a configuration.
  - disable:       mark a configuration as ineligible to run. 
  - enable:        mark a configuration as eligible to run.
- - convert:       converts a v2 config to a v3 config.
+ - convert:       converts v2 configs to a v3 config.
 
 
 For example:  *sr3 foreground subscribe/dd* runs the subscribe component with
@@ -103,7 +103,7 @@ started or restarted by the **start**,
 **foreground**, or **restart** actions. It can be used to set aside a configuration
 temporarily. 
 
-The **convert** action is used to translate a configuration file written with Sarracenia version 2
+The **convert** action is used to translate configuration files written with Sarracenia version 2
 options into Sarracenia version 3 options. The v2 configuration file must be placed in the
 *~/.config/sarra/component/v2_config.conf* directory and the translated version will be placed in
 the *~/.config/sr3/component/v3_config.conf* directory. For example, one would invoke this action
@@ -396,6 +396,11 @@ Converting a config: both formats are accepted, as well as include files::
   $ sr3 convert shovel/no_trouble_f00.inc
     2022-06-14 15:03:29,918 1093655 [INFO] root convert converting shovel/no_trouble_f00.inc from v2 to v3
 
+To overwrite an existing sr3 configuration use the *--wololo* option.
+When overwriting multiple sr3 configurations, one must also use *--dangerWillRobinson=n* in the 
+normal way... where *n* is the number of configurations to convert.
+
+
 start
 ~~~~~
 

diff --git a/docs/source/Reference/sr3.1.rst b/docs/source/Reference/sr3.1.rst
@@ -61,7 +61,7 @@ The type of action to take. One of:
 
  - add:           copy to the list of available configurations.
  - cleanup:       deletes the component's resources on the server.
- - convert:       copy a configuration from v2 to sr3 location, updating on the way.
+ - convert:       copy configurations from v2 to sr3 location, updating on the way.
  - declare:       creates the component's resources on the server.
  - disable:       mark a configuration as ineligible to run.
  - edit:          modify an existing configuration.

diff --git a/docs/source/Reference/sr3_options.7.rst b/docs/source/Reference/sr3_options.7.rst
@@ -1955,6 +1955,14 @@ When an **sr3 instance** does not find the vip, it sleeps for 5 seconds and retr
 If it does, it consumes and processes a message and than rechecks for the vip.
 Multiple vips form a list, where any individual address being active is enough.
 
+wololo 
+------
+
+A command line option to overwite an existing sr3 configuration when converting
+from v2.
+
+
+
 SEE ALSO
 ========
 

diff --git a/docs/source/fr/Explication/GuideLigneDeCommande.rst b/docs/source/fr/Explication/GuideLigneDeCommande.rst
@@ -397,6 +397,11 @@ Conversion d’une configuration : les deux formats sont acceptés, ainsi que le
   $ sr3 convert shovel/no_trouble_f00.inc
     2022-06-14 15:03:29,918 1093655 [INFO] root convert converting shovel/no_trouble_f00.inc from v2 to v3
 
+Pour écraser une configuration SR3 existante, utilisez l'option *--wololo*.
+Lors de l'écrasement de plusieurs configurations SR3 est voulu, il faut également 
+utiliser *--dangerWillRobinson=n* dans le mode normale... où *n* est le nombre de configurations à convertir.
+
+
 start
 ~~~~~
 

diff --git a/docs/source/fr/Reference/sr3.1.rst b/docs/source/fr/Reference/sr3.1.rst
@@ -61,7 +61,7 @@ Les types d'actions disponible. Une seule parmi:
 
  - add:           copier a la liste de configurations disponible.
  - cleanup:       supprimer les ressources des composants sur le serveur.
- - convert:       copie et mets à jour une configuration de v2 dans le répertoire sr3.
+ - convert:       copie et mets à jour un ou plusieurs configuration de v2 dans le répertoire sr3.
  - declare:       crée les ressources d'un composant sur le serveur.
  - disbale:       marquer une configuration comme non-éligible à exécuter.
  - edit:          modifier une configuration existante.

diff --git a/docs/source/fr/Reference/sr3_options.7.rst b/docs/source/fr/Reference/sr3_options.7.rst
@@ -1915,6 +1915,12 @@ Lorsqu’une **instance sr3** ne trouve pas l’adresse IP, elle se met en veill
 Si c’est le cas, elle consomme et traite un message d'annonce et revérifie pour le vip.
 lorsque plus qu'un vip est spécifié, n´importe lequel des addresses IP dans la liste est suffisant.
 
+wololo
+------
+
+Une option de ligne de commande pour écraser une configuration SR3 existante lors de la conversion
+à partir de la v2.
+
 SEE ALSO
 ========