diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2018-03-05 14:43:59 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2018-03-05 14:43:59 +0200 |
| commit | ce63b6fa454053a4bd8ff3a1f4855821ca97c214 (patch) | |
| tree | 67fb2b29726429108a22d046a3b72207f00a0d09 | |
| parent | 626b127c412ac264c464dfb0cd24dbd8caaefd86 (diff) | |
Style/naming cleanup in man synopsis
| -rw-r--r-- | build2/b.cli | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/build2/b.cli b/build2/b.cli index 6114763..dc5b2b0 100644 --- a/build2/b.cli +++ b/build2/b.cli @@ -11,22 +11,26 @@ include <build2/types.hxx>; namespace build2 { { - "<options> <variables> <buildspec>", + "<options> + <variables> + <build-spec> <meta-operation> <operation> <target> <parameters>", "\h|SYNOPSIS| - \cb{b --help}\n - \cb{b --version}\n - \c{\b{b} [<options>] [<variables>] [<buildspec>]} + \c{\b{b --help}\n + \b{b --version}\n + \b{b} [<options>] [<variables>] [<build-spec>]} + + \c{<build-spec> = <meta-operation>\b{(}<operation>\b{(}<target>...[\b{,}<parameters>]\b{)}...\b{)}...} \h|DESCRIPTION| The \cb{build2} driver executes a set of meta-operations on operations on - targets according to the build specification, or <buildspec> for short. + targets according to the build specification, or \i{buildspec} for short. This process can be controlled by specifying driver <options> and build system <variables>. - Note that <options>, <variables>, and <buildspec> fragments can be + Note that <options>, <variables>, and <build-spec> fragments can be specified in any order. To avoid treating an argument that starts with \cb{'-'} as an option, add the \cb{'--'} separator. To avoid treating an argument that contains \cb{'='} as a variable, add the second \cb{'--'} @@ -40,11 +44,7 @@ namespace build2 "<meta-operation> <operation> <target> <parameters> <src-base>", "", - "The buildspec has the following form: - - \c{<meta-operation>(<operation>(<target>...[,<parameters>])...)...} - - All components in the buildspec can be omitted. If <meta-operation> is + "All components in the buildspec can be omitted. If <meta-operation> is omitted, then it defaults to \cb{perform}. If <operation> is omitted, then it defaults to the default operation for this meta-operation. For \cb{perform} it is \cb{update}. Finally, if <target> is omitted, then it |