aboutsummaryrefslogtreecommitdiff
path: root/bpkg/cfg-create.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/cfg-create.cli
parentad257079568746d71d913c6fca96852da6fe3bd6 (diff)
Documentation improvements
Diffstat (limited to 'bpkg/cfg-create.cli')
-rw-r--r--bpkg/cfg-create.cli9
1 files changed, 5 insertions, 4 deletions
diff --git a/bpkg/cfg-create.cli b/bpkg/cfg-create.cli
index e28778e..2f6070d 100644
--- a/bpkg/cfg-create.cli
+++ b/bpkg/cfg-create.cli
@@ -15,7 +15,7 @@ namespace bpkg
"\h|SYNOPSIS|
- \c{\b{bpkg cfg-create} [<options>] [(<module> | <conf-var>)...]}
+ \c{\b{bpkg cfg-create}|\b{create} [<options>] [(<module> | <conf-var>)...]}
\h|DESCRIPTION|
@@ -25,7 +25,7 @@ namespace bpkg
configuration directory to be empty or to not exist (in which case it
will be created).
- By default the resulting configuration loads the \cb{config}, \cb{test},
+ By default, the resulting configuration loads the \cb{config}, \cb{test},
and \cb{install} modules. However, additional modules and, if required,
their configuration variables can be specified as the \cb{cfg-create}
arguments. For example:
@@ -43,14 +43,15 @@ namespace bpkg
dir_path --directory|-d (".")
{
"<dir>",
- "Create configuration in <dir> rather than in the current working
+ "Create the configuration in <dir> rather than in the current working
directory."
}
bool --wipe
{
"Wipe the configuration directory clean before creating the new
- configuration."
+ configuration. For safety, this option requires that you specify the
+ configuration directory explicitly with \cb{--directory|-d}."
}
};
}