From 1ab282b906ab6e4bbf9431a7ee89efe7bc66b414 Mon Sep 17 00:00:00 2001 From: David Rheinsberg Date: Wed, 18 Mar 2020 08:34:13 +0100 Subject: [PATCH] docs: fix incorrect option-list formatting 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. --- docs/osbuild.1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/osbuild.1.rst b/docs/osbuild.1.rst index b3cd65c0..7c1fa141 100644 --- a/docs/osbuild.1.rst +++ b/docs/osbuild.1.rst @@ -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)