From 28bf74a975589e6136c39ec679f2e4ddc089f649 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Thu, 24 Oct 2019 10:19:24 +0200 Subject: Fix bdep-sync documentation --- bdep/init.cxx | 2 ++ bdep/sync.cli | 14 +++++++------- 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 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 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, -- cgit v1.1