aboutsummaryrefslogtreecommitdiff
path: root/bdep/config.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2018-03-25 11:31:25 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2018-03-25 11:35:48 +0200
commita8a4960776efd695d89e74f7d83ac4daf619fc3d (patch)
tree53220bdab36baa0dca609ee2e4d3a602c0caf178 /bdep/config.cli
parente2b8f68fcae70fca5971167613916a1aa9480817 (diff)
Document config command
Diffstat (limited to 'bdep/config.cli')
-rw-r--r--bdep/config.cli55
1 files changed, 47 insertions, 8 deletions
diff --git a/bdep/config.cli b/bdep/config.cli
index 37f7ae2..0cb4712 100644
--- a/bdep/config.cli
+++ b/bdep/config.cli
@@ -38,14 +38,53 @@ namespace bdep
\h|DESCRIPTION|
- The \cb{config} command...
-
- Unless the \cb{--no-default} option is specified, the first added or
- created build configuration is designated as the default. Several
- \cb{bdep} commands use such a configuration by default if no
- configuration was specified explicitly (see \l{bdep-projects-configs(1)}
- for details). To make a subsequently added configuration the default use
- the \cb{--default} option.
+ The \cb{config} command provides the following subcommands for managing
+ project's build configurations.
+
+ \dl|
+
+ \li|\cb{add}
+
+ |
+
+ \li|\cb{create}
+
+ The \cb{add} subcommand adds an existing \l{bpkg(1)} configuration in
+ directory <cfg-dir> to the project's build configuration set. The
+ \cb{create} subcommand creates a new configuration in directory
+ <cfg-dir> by executing the \l{bpkg-cfg-create(1)} command and passing
+ to it <cfg-args>, if any. It then proceeds as \cb{add} by adding the
+ new configuration to the project's build configuration set.
+
+ In both subcommands, if <cfg-name> is specified, then the added
+ configuration is given this name. Several \cb{bdep} commands can use
+ such names as a more convenient way to specify build configurations
+ (see \l{bdep-projects-configs(1)} for details).
+
+ Unless the \cb{--no-default} option is specified, the first added or
+ created build configuration is designated as the default. Several
+ \cb{bdep} commands use such a configuration by default if no
+ configuration was specified explicitly (see
+ \l{bdep-projects-configs(1)} for details). To make a subsequently
+ added configuration the default use the \cb{--default} option.|
+
+ \li|\cb{remove}
+
+ The \cb{remove} subcommand removes one or more configurations from
+ the project's build configuration set. See
+ \l{bdep-projects-configs(1)} for various ways to specify build
+ configurations.|
+
+ \li|\cb{rename}
+
+ The \cb{rename} subcommand gives the specified build configuration
+ a new name.|
+
+ \li|\cb{set}
+
+ The \cb{set} subcommand sets various properties of the specified
+ build configuration. These include the default flag
+ (\c{\b{--}[\b{no-}]\b{default}}).||
"
}