Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
small doc improvement
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Thu, 16 May 2019 13:54:57 +0000 (15:54 +0200)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Fri, 17 May 2019 21:51:44 +0000 (23:51 +0200)
docs/source/Configuring_SimGrid.rst
src/simgrid/sg_config.cpp

index ac9affc..9bed9da 100644 (file)
@@ -79,7 +79,10 @@ Existing Configuration Items
 
 .. note::
   The full list can be retrieved by passing ``--help`` and
-  ``--help-cfg`` to an executable that uses SimGrid.
+  ``--help-cfg`` to an executable that uses SimGrid. Try passing
+  ``help`` as a value to get the list of values accepted by a given
+   option. For example, ``--cfg=plugin:help`` will give you the list
+   of plugins available in your installation of SimGrid.
 
 - **clean-atexit:** :ref:`cfg=clean-atexit`
 
index 816d265..1cbf235 100644 (file)
@@ -68,7 +68,10 @@ static void sg_config_cmd_line(int *argc, char **argv)
       XBT_HELP("\n"
                "Each of these configurations can be used by adding\n"
                "    --cfg=<option name>:<option value>\n"
-               "to the command line.\n"
+               "to the command line. Try passing \"help\" as a value\n"
+               "to get the list of values accepted by a given option.\n"
+               "For example, \"--cfg=plugin:help\" gives you the list of\n"
+               "plugins available in your installation of SimGrid.\n"
                "\n"
                "For more information, please refer to:\n"
                "   --help-aliases for the list of all option aliases.\n"