aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2018-03-25 16:28:31 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2018-03-25 16:28:31 +0200
commit584de3709037e81d821f8cc2d94fd3b87b4ae3b1 (patch)
tree4662850fd97ebdd814fbc70cc27841152a858776
parent8b2d9f6faf3ca532aadcd48e329761a913299bd6 (diff)
Documentation improvements
-rw-r--r--bdep/config.cli3
-rw-r--r--bdep/fetch.cli8
-rw-r--r--bdep/projects-configs.cli2
-rw-r--r--bdep/status.cli18
-rw-r--r--bdep/sync.cli6
5 files changed, 25 insertions, 12 deletions
diff --git a/bdep/config.cli b/bdep/config.cli
index 0cb4712..067fd69 100644
--- a/bdep/config.cli
+++ b/bdep/config.cli
@@ -39,7 +39,8 @@ namespace bdep
\h|DESCRIPTION|
The \cb{config} command provides the following subcommands for managing
- project's build configurations.
+ project's build configurations. If no project directory is specified,
+ then the current working directory is assumed.
\dl|
diff --git a/bdep/fetch.cli b/bdep/fetch.cli
index 60e20f4..04169b3 100644
--- a/bdep/fetch.cli
+++ b/bdep/fetch.cli
@@ -24,8 +24,12 @@ namespace bdep
\h|DESCRIPTION|
- The \cb{fetch} command re-fetches the list of available packages in the
- project's prerequisite and complement repositories, recursively.
+ The \cb{fetch} command fetches the list of packages available in the
+ project's repositories in one or more build configurations. If no project
+ or package directory is specified, then the current working directory is
+ assumed. If no configuration is specified, the the default configuration
+ is assumed. See \l{bdep-projects-configs(1)} for details on specifying
+ projects and configurations.
If the \cb{--full|-F} option is specified, then instead \cb{fetch}
performs a full re-fetch of all the repositories added to the
diff --git a/bdep/projects-configs.cli b/bdep/projects-configs.cli
index 7b3e175..256d0a1 100644
--- a/bdep/projects-configs.cli
+++ b/bdep/projects-configs.cli
@@ -28,7 +28,7 @@ include <bdep/common-options.hxx>;
Most \cb{bdep} commands operate on a project or some of its packages as well
as its build configurations. For example, \cb{status} (\l{bdep-status(1)})
shows the status of one or more project packages in one or more build
- configurations. While \cb{fetch} (\l{bdep-fetch(1)}) re-fetches the list of
+ configurations. While \cb{fetch} (\l{bdep-fetch(1)}) fetches the list of
available to the project dependency packages, again, in one or more build
configurations.
diff --git a/bdep/status.cli b/bdep/status.cli
index 8ef909b..c37a85c 100644
--- a/bdep/status.cli
+++ b/bdep/status.cli
@@ -29,14 +29,18 @@ namespace bdep
\h|DESCRIPTION|
The \cb{status} command prints the status of project packages and/or
- their dependencies in build configurations. If no <dep-spec> arguments
- are specified, then \cb{status} prints the status of the project's
- packages. Otherwise, the status of the specified dependency packages is
- printed. Additionally, the status of immediate or all dependencies of the
- above packages can be printed by specifying the
+ their dependencies in one or more build configurations. If no project or
+ package directory is specified, then the current working directory is
+ assumed. If no configuration is specified, the the default configuration
+ is assumed. See \l{bdep-projects-configs(1)} for details on specifying
+ projects and configurations.
+
+ If no <dep-spec> arguments are specified, then \cb{status} prints the
+ status of the project's packages. Otherwise, the status of the specified
+ dependency packages is printed. Additionally, the status of immediate or
+ all dependencies of the above packages can be printed by specifying the
\c{\b{--immediate}|\b{-i}} or \c{\b{--recursive}|\b{-r}} options,
- respectively. See \l{bdep-projects-configs(1)} for details on specifying
- packages (<pkg-spec>) and configurations (<cfg-spec>).
+ respectively.
The status of each package is printed on a separate line. Note that the
status is written to \cb{STDOUT}, not \cb{STDERR}. The semantics of
diff --git a/bdep/sync.cli b/bdep/sync.cli
index 79bb91d..d65a2e7 100644
--- a/bdep/sync.cli
+++ b/bdep/sync.cli
@@ -36,7 +36,11 @@ namespace bdep
configurations. The first form (no arguments nor \cb{--upgrade} or
\cb{--patch} are specified) upgrades the project packages to the latest
iteration, adjusts their dependencies according to the latest manifest
- information, and updates the lockfile.
+ information, and updates the lockfile. If no project or package directory
+ is specified, then the current working directory is assumed. If no
+ configuration is specified, the the default configuration is assumed. See
+ \l{bdep-projects-configs(1)} for details on specifying projects and
+ configurations.
The second form (no arguments but either \cb{--upgrade} or \cb{--patch}
is specified), in addition to the first form's functionality, also