Skip to content

Commit f958833

Browse files
authored
bob-[dev, build] manpage: improve command syntax descriptions (#653)
Unify the description of the option syntax. Add the long option where one is available.
2 parents c8a6f87 + cb94a1a commit f958833

File tree

4 files changed

+18
-13
lines changed

4 files changed

+18
-13
lines changed

doc/manpages/bob-build-dev.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,9 @@ Options
170170
forced=<layer regex>
171171
like 'yes' above, but fail if any download fails
172172

173+
``-h, --help``
174+
Show this help message and exit.
175+
173176
``--incremental``
174177
Reuse build directory for incremental builds.
175178

@@ -302,7 +305,7 @@ Options
302305
will skip the execution of it if this is not the case. With this option Bob
303306
not use that optimization and will execute all build steps.
304307

305-
``-j, --jobs``
308+
``-j, --jobs [JOBS]``
306309
Specifies the number of jobs to run simultaneously.
307310

308311
Any checkout/build/package step that needs to be executed are counted as a

doc/manpages/bob-build.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ Synopsis
1515

1616
::
1717

18-
bob build [-h] [--destination DEST] [-j [JOBS]] [-k] [-f] [-n] [-p]
19-
[--without-provided] [-A | --audit] [-b | -B | --normal]
18+
bob build [-h, --help] [--destination DEST] [-j, --jobs [JOBS]] [-k, --keep-going] [-f, --force]
19+
[-n, --no-deps] [-p, --with-provided] [--without-provided] [-A | --no-audit]
20+
[-b, --build-only | -B, --checkout-only | --normal]
2021
[--clean | --incremental] [--always-checkout RE] [--resume]
21-
[-q] [-v] [--no-logfiles] [-D DEFINES] [-c CONFIGFILE]
22-
[-lc LAYERCONFIG] [-e NAME] [-E] [-M META] [--upload]
22+
[-q, --quiet] [-v, --verbose] [--no-logfiles] [-D VAR=VALUE] [-c CONFIGFILE]
23+
[-lc LAYERCONFIG] [-e NAME] [-E] [-M VAR=VALUE] [--upload]
2324
[--link-deps] [--no-link-deps] [--download MODE]
2425
[--download-layer MODE] [--shared | --no-shared]
2526
[--install | --no-install]

doc/manpages/bob-dev.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ Synopsis
1515

1616
::
1717

18-
bob dev [-h] [--destination DEST] [-j [JOBS]] [-k] [-f] [-n] [-p]
19-
[--without-provided] [-A | --audit] [-b | -B | --normal]
18+
bob dev [-h, --help] [--destination DEST] [-j, --jobs [JOBS]] [-k, --keep-going] [-f, --force]
19+
[-n, --no-deps] [-p, --with-provided] [--without-provided] [-A | --no-audit]
20+
[-b, --build-only | -B, --checkout-only | --normal]
2021
[--clean | --incremental] [--always-checkout RE] [--resume]
21-
[-q] [-v] [--no-logfiles] [-D DEFINES] [-c CONFIGFILE]
22-
[-lc LAYERCONFIG] [-e NAME] [-E] [-M META] [--upload]
22+
[-q, --quiet] [-v, --verbose] [--no-logfiles] [-D VAR=VALUE] [-c CONFIGFILE]
23+
[-lc LAYERCONFIG] [-e NAME] [-E] [-M VAR=VALUE] [--upload]
2324
[--link-deps] [--no-link-deps] [--download MODE]
2425
[--download-layer MODE] [--shared | --no-shared]
2526
[--install | --no-install]

pym/bob/cmds/build/build.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,8 @@ def _downloadLayerArgument(arg):
169169
help="Increase verbosity (may be specified multiple times)")
170170
parser.add_argument('--no-logfiles', default=None, action='store_true',
171171
help="Disable logFile generation.")
172-
parser.add_argument('-D', default=[], action='append', dest="defines",
173-
help="Override default environment variable")
172+
parser.add_argument('-D', metavar="VAR=VALUE", default=[], action='append', dest="defines",
173+
help="Override default or set environment variable <VAR> with value <VALUE>")
174174
parser.add_argument('-c', dest="configFile", default=[], action='append',
175175
help="Use config File")
176176
parser.add_argument('-lc', dest="layerConfig", default=[], action='append',
@@ -179,8 +179,8 @@ def _downloadLayerArgument(arg):
179179
help="Preserve environment variable")
180180
parser.add_argument('-E', dest="preserve_env", default=False, action='store_true',
181181
help="Preserve whole environment")
182-
parser.add_argument('-M', default=[], action='append', dest="meta",
183-
help="Add meta key to audit trail")
182+
parser.add_argument('-M', metavar="VAR=VALUE", default=[], action='append', dest="meta",
183+
help="Add meta variable <VAR> to audit trail")
184184
parser.add_argument('--upload', default=None, action='store_true',
185185
help="Upload to binary archive")
186186
parser.add_argument('--link-deps', default=None, help="Add linked dependencies to workspace paths",

0 commit comments

Comments
 (0)