diff options
Diffstat (limited to 'src/options/README.md')
| -rw-r--r-- | src/options/README.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/src/options/README.md b/src/options/README.md index c3e018215..2f89f04ee 100644 --- a/src/options/README.md +++ b/src/options/README.md @@ -26,7 +26,7 @@ Specifying Options Options can be defined within a module file with the `[[option]]` tag, the required attributes for an option are: -* `category` (string): one of `common`, `expert`, `regular`, or `undocumented` +* `category` (string): one of `common`, `regular`, `expert`, or `undocumented` * `type` (string): the C++ type of the option value, see below for more details. Optional attributes are: @@ -59,6 +59,16 @@ Optional attributes are: given) +Option categories +----------------- + +Every option has one of the following categories that influences where and how an option is visible: + +* `common`: Used for the most common options. All `common` options are shown at the very top in both the online documentation and the output of `--help` on the command line. +* `regular`: This should be used for most options. +* `expert`: This is for options that should be used with care only. A warning is shown in both the online documentation and the command line help. +* `undocumented`: Such an option is skipped entirely in both the online documentation and the command line help. This should only be used when users don't have a (reasonable) use case for this option (e.g., because it stores data that is added via another option like for `output` and `outputTagHolder`). + Option types ------------ |