aboutsummaryrefslogtreecommitdiff
path: root/bpkg/bpkg.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2018-02-10 12:19:27 +0200
committerKaren Arutyunov <karen@codesynthesis.com>2018-02-12 17:35:01 +0300
commit1ac50a35f4183cd7cd4bae0b310e20474a2d1f69 (patch)
tree2dfc7a4fd9d69165b4c9b9d5bd91868bdd266f99 /bpkg/bpkg.cli
parentb7763416f8a1e4940a10336d3a8b9fbbb879f414 (diff)
Document git repository-related functionality
Diffstat (limited to 'bpkg/bpkg.cli')
-rw-r--r--bpkg/bpkg.cli8
1 files changed, 5 insertions, 3 deletions
diff --git a/bpkg/bpkg.cli b/bpkg/bpkg.cli
index d2d543f..6b705d1 100644
--- a/bpkg/bpkg.cli
+++ b/bpkg/bpkg.cli
@@ -51,13 +51,14 @@ namespace bpkg
amalgamation that contains packages as subprojects.
A \i{bpkg package} is an archive or directory that contains a \cb{build2}
- project plus a package \cb{manifest} file. \cb{bpkg} can either use
+ project plus the package \cb{manifest} file. \cb{bpkg} can either use
package archives/directories directly from the filesystem or it can fetch
archives from repositories.
A \i{bpkg repository} is a collection of packages as well as prerequisite
- and complement repositories. A repository is identified by its location,
- which can be a local filesystem path or a remote HTTP or HTTPS URL.
+ and complement repositories. Both \i{archive} and \i{version
+ control}-based repository types are supported. A repository is identified
+ by its location which can be a local filesystem path or a URL.
A typical \cb{bpkg} workflow would consist of the following steps.
@@ -76,6 +77,7 @@ namespace bpkg
\
bpkg add https://pkg.cppget.org/1/stable
+ bpkg add https://git.build2.org/hello/libhello.git#master
\
Repeat this command to add more repositories.