aboutsummaryrefslogtreecommitdiff
path: root/bpkg/common.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-01-11 15:14:32 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-01-11 15:14:32 +0200
commit1c13ae4ed5d84b32c2c1a0698f9e688c312de989 (patch)
tree4977cf7df549e275205e9ced6ae283ac89c685c4 /bpkg/common.cli
parentad257079568746d71d913c6fca96852da6fe3bd6 (diff)
Documentation improvements
Diffstat (limited to 'bpkg/common.cli')
-rw-r--r--bpkg/common.cli14
1 files changed, 7 insertions, 7 deletions
diff --git a/bpkg/common.cli b/bpkg/common.cli
index 17ee1a6..92c3748 100644
--- a/bpkg/common.cli
+++ b/bpkg/common.cli
@@ -6,7 +6,7 @@ include <bpkg/types>;
"\section=1"
"\name=bpkg-common-options"
-"\summary=options common for all commands"
+"\summary=details on common options"
namespace bpkg
{
@@ -19,8 +19,9 @@ namespace bpkg
\h|DESCRIPTION|
- The common options can be specified either before the command or after,
- togethere with the command-specific options."
+ The common options control behavior that is common to all or most of the
+ \cb{bpkg} commands. They can be specified either before the command or
+ after, together with the command-specific options."
}
class common_options = 0
@@ -32,8 +33,7 @@ namespace bpkg
{
"",
"The common options are summarized below with a more detailed description
- available as the \l{bpkg-common-options(1) \cb{common-options}} help
- topic.",
+ available in \l{bpkg-common-options(1)}.",
""
}
@@ -61,9 +61,9 @@ namespace bpkg
\li|high-level information messages|
- \li|essential underlying commands that are being executed|
+ \li|essential underlying commands being executed|
- \li|all underlying commands that are being executed|
+ \li|all underlying commands being executed|
\li|information that could be helpful to the user|