diff options
| -rw-r--r-- | bdep/bdep.cli | 13 | ||||
| -rw-r--r-- | bdep/config.cli | 44 | ||||
| -rw-r--r-- | bdep/init.cli | 42 | ||||
| -rwxr-xr-x | doc/cli.sh | 2 | ||||
| m--------- | doc/style | 0 |
5 files changed, 92 insertions, 9 deletions
diff --git a/bdep/bdep.cli b/bdep/bdep.cli index 67460b0..637803c 100644 --- a/bdep/bdep.cli +++ b/bdep/bdep.cli @@ -15,10 +15,10 @@ namespace bdep "\h|SYNOPSIS| - \cb{bdep --help}\n - \cb{bdep --version}\n - \c{\b{bdep help} [<command> | <topic>]}\n - \c{\b{bdep} [<common-options>] <command> [<command-options>] <command-args>} + \c{\b{bdep --help}\n + \b{bdep --version}\n + \b{bdep help} [<command> | <topic>]\n + \b{bdep} [<common-options>] <command> [<command-options>] <command-args>} \h|DESCRIPTION| @@ -59,6 +59,11 @@ namespace bdep "" } + bool config + { + "\l{bdep-config(1)} \- manage project's build configurations" + } + bool init { "\l{bdep-init(1)} \- @@ TODO" diff --git a/bdep/config.cli b/bdep/config.cli new file mode 100644 index 0000000..73d5444 --- /dev/null +++ b/bdep/config.cli @@ -0,0 +1,44 @@ +// file : bdep/config.cli +// copyright : Copyright (c) 2014-2017 Code Synthesis Ltd +// license : MIT; see accompanying LICENSE file + +include <bdep/common.cli>; + +"\section=1" +"\name=bdep-config" +"\summary=manage project build configurations" + +namespace bdep +{ + { + "<options> + <cfg-spec> <cfg-name> <cfg-dir> + <prj-spec> <prj-dir> + <cfg-args> <cfg-var> <module>", + + "\h|SYNOPSIS| + + \c{\b{bdep config add} \ \ \ [<options>] [<prj-spec>] [\b{@}<cfg-name>] <cfg-dir>\n + \b{bdep config create} [<options>] [<prj-spec>] [\b{@}<cfg-name>] <cfg-dir> [<cfg-args>]\n + \b{bdep config remove} [<options>] [<prj-spec>] <cfg-spec>} + + \c{<prj-spec> = \b{--directory}|\b{-d} <prj-dir>\n + <cfg-args> = (<module> | <cfg-var>)...\n + <cfg-spec> = (\b{@}<cfg-name> | \b{--config}|\b{-c} <cfg-dir>)... | \b{--all}|\b{-a}} + + \h|DESCRIPTION| + + The \cb{config} command..." + } + + class config_options: common_options + { + "\h|CONFIG OPTIONS|" + + bool --default|-d + { + //@@ Need to explain what it means. + "Make the added or created configuration default." + } + }; +} diff --git a/bdep/init.cli b/bdep/init.cli index 75178f8..f91fbc0 100644 --- a/bdep/init.cli +++ b/bdep/init.cli @@ -6,20 +6,54 @@ include <bdep/common.cli>; "\section=1" "\name=bdep-init" -"\summary=@@ TODO" +"\summary=initialize project dependency management" namespace bdep { { - "<options>", + "<options> + <prj-spec> <prj-dir> + <pkg-spec> <pkg-dir> + <cfg-spec> <cfg-name> <cfg-dir> + <cfg-args> <cfg-var> <module> + <pkg-args> <pkg>", "\h|SYNOPSIS| - \c{\b{bdep init} [<options>] @@ TODO} + \c{\b{bdep init} [<options>] [<pkg-spec>] [<cfg-spec>] [<pkg-args>]\n + \b{bdep init} [<options>] [<pkg-spec>] \b{--add} <cfg-dir> [\b{@}<cfg-name>]\n + \b{bdep init} [<options>] [<pkg-spec>] \b{--create} <cfg-dir> [\b{@}<cfg-name>] [<cfg-args>]\n + \b{bdep init} [<options>] [<prj-spec>] \b{--empty}} + + \c{<prj-spec> = \b{--directory}|\b{-d} <prj-dir>\n + <pkg-spec> = (\b{--directory}|\b{-d} <pkg-dir>)... | <prj-spec>\n + <cfg-spec> = (\b{@}<cfg-name> | \b{--config}|\b{-c} <cfg-dir>)... | \b{--all}|\b{-a}\n + <pkg-args> = (<pkg> | <cfg-var>)...\n + <cfg-args> = (<module> | <cfg-var>)...} \h|DESCRIPTION| - The \cb{init} command..." + The \cb{init} command... + + If <cfg-spec> is omitted, then the default configuration is assumed. + + If <pkg-spec> is omitted, then the current working directory is + assumed. In this case the current directory must be either a project + directory (<prj-dir>), a package directory (<pkg-dir>) or a subdirectory + of package directory. + + <cfg-args> are arguments to \cb{bpkg cfg-create}. <pkg-args> are arguments + to \cb{bpkg pkg-build}. + + In the first variant the configurations can also be specified as + directories using the \cb{--config|-c} option. + + The second and third variants are semantically equivalent to first + performing \cb{config add} and \cb{config create} (\l{bdep-config(1)}), + respectively, followed by the first variant. In both cases the + \cb{--default|-d} option can be used to make the added/created + configuration default. + " } class init_options: common_options @@ -56,7 +56,7 @@ o="--output-prefix bdep- --class-doc bdep::common_options=short" compile "common" $o --output-suffix "-options" --class-doc bdep::common_options=long compile "bdep" $o --output-prefix "" --suppress-undocumented --class-doc bdep::commands=short --class-doc bdep::topics=short -pages="bdep common help init" +pages="config help init" for p in $pages; do compile $p $o diff --git a/doc/style b/doc/style -Subproject 658436a9522b5a0d016c3da0253708093607f95 +Subproject f9ae99d1bef56a056cbcac5a4411cfdd3e76ac3 |