particle-os/debian-forge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: fix incorrect option-list formatting

Browse source 
The used format of `-X, --long=VALUE` is not a valid option-list entry,
even though it is very commonly used all over the linux man-pages. Use
the supported format of `-X VALUE, --long=VALUE`, which will format
correctly in the man-page and html outputs.

For reference, these formats are valid in RST option-lists:

        -a                      Short option
        -c arg                  Short option with arg.
        --long                  Long option.
        -2, --two               Aliases on a single line.
        -f FILE, --file=FILE    Aliases with arguments.
        /V                      VMS/DOS-style option.
This commit is contained in:
David Rheinsberg 2020-03-18 08:34:13 +01:00
parent c8465ce06f
commit 1ab282b906
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/osbuild.1.rst
View file

@ -45,7 +45,7 @@ is not listed here, **osbuild** will deny startup and exit with an error.
configuration
--secrets=PATH json file containing a dictionary of secrets
that are passed to sources
-l, --libdir=DIR directory containing stages, assemblers, and
-l DIR, --libdir=DIR directory containing stages, assemblers, and
the osbuild library
--checkpoint=CHECKPOINT stage to commit to the object store during
build (can be passed multiple times)