aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2019-10-24 10:19:24 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2019-10-24 10:19:24 +0200
commit28bf74a975589e6136c39ec679f2e4ddc089f649 (patch)
tree60f7a8a30ebb0ddd77d1b5d168fd88220ec203db
parent44d5647b4b92089fc90195b41373f6b99dc5c42c (diff)
Fix bdep-sync documentation
-rw-r--r--bdep/init.cxx2
-rw-r--r--bdep/sync.cli14
2 files changed, 9 insertions, 7 deletions
diff --git a/bdep/init.cxx b/bdep/init.cxx
index 1abff60..04afd3c 100644
--- a/bdep/init.cxx
+++ b/bdep/init.cxx
@@ -117,6 +117,8 @@ namespace bdep
// error. This can be worked around by disabling the implicit sync
// (BDEP_SYNC=0).
//
+ // Note: semantically equivalent to the first form of the sync command.
+ //
cmd_sync (o, prj, c, pkg_args, false /* implicit */);
db.update (c);
diff --git a/bdep/sync.cli b/bdep/sync.cli
index a2f3966..04b8330 100644
--- a/bdep/sync.cli
+++ b/bdep/sync.cli
@@ -35,10 +35,10 @@ namespace bdep
\h|DESCRIPTION|
The \cb{sync} command synchronizes a project with its build
- configurations. The first form (no arguments nor \cb{--upgrade} or
- \cb{--patch} are specified) upgrades the project packages to the latest
- version/iteration, adjusts their dependencies according to the latest
- manifest information, and updates the lockfile.
+ configurations. The first form (no \cb{--upgrade} or \cb{--patch} and
+ only <pkg-args> arguments, if any, are specified) upgrades the project
+ packages to the latest version/iteration, adjusts their dependencies
+ according to the latest manifest 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, then the default
@@ -54,9 +54,9 @@ namespace bdep
\c{\b{--recursive}|\b{-r}} is specified) dependencies of the specified
project packages.
- The third form (one or more arguments are specified), in addition to the
- first form's functionality, also upgrades (by default or if
- \cb{--upgrade} is specified) or patches (if \cb{--patch} is specified)
+ The third form (one or more <dep-spec> arguments are specified), in
+ addition to the first form's functionality, also upgrades (by default or
+ if \cb{--upgrade} is specified) or patches (if \cb{--patch} is specified)
the specified dependencies. If \c{\b{--immediate}|\b{-i}} or
\c{\b{--recursive}|\b{-r}} is specified, then it also upgrades or patches
the immediate or all dependencies of the specified dependencies,