diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2018-02-13 15:02:00 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2018-02-13 15:02:00 +0200 |
| commit | 1095eeb448930c04acf1aab6a1061c72607a5580 (patch) | |
| tree | e6c58de5d6e2b78c2b4fbac6acc3793b352844b4 /bpkg/rep-add.cli | |
| parent | 5a8cd1a0cf9cf1843fea491dc1eaba15e7cdbee0 (diff) | |
Document packages and repositories files for git repositories
Diffstat (limited to 'bpkg/rep-add.cli')
| -rw-r--r-- | bpkg/rep-add.cli | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/bpkg/rep-add.cli b/bpkg/rep-add.cli index 3925074..ff202a5 100644 --- a/bpkg/rep-add.cli +++ b/bpkg/rep-add.cli @@ -38,7 +38,8 @@ namespace bpkg A bpkg repository is \i{archive}-based. That is, it contains a collection of various packages/versions as archive files. For more information on - the structure of bpkg repositories refer to the \cb{bpkg} manual. + the structure of bpkg repositories refer to the \l{bpkg \cb{bpkg} + manual}. A git repository is \i{version control}-based. That is, it normally contains multiple versions of the same package (but can also contain @@ -85,17 +86,14 @@ namespace bpkg contains \cb{manifest}, then it is assumed to be a single-package repository with the \cb{manifest} file being its package manifest. Otherwise the \cb{packages} file should list the available packages as - directory paths relative to the repository root (which in turn should - contain the \cb{manifest} files). The \cb{packages} file is a manifest - (see the \cb{bpkg} manual for details on the manifest file format) that - should contain one or more \cb{location} values in the POSIX path - representation. For example: - - \ - : 1 - location: src/libfoo/ - location: src/foo/ - \ + described in \l{bpkg#manifest-package-list-git Package List Manifest for + \c{git} Repositories}. + + A git repository may also contain the \cb{repositories} file in the root + directory of the repository. This file can be used to describe the + repository itself as well as specify its prerequisite and complement + repositories. See \l{bpkg#manifest-repository-list Repository List + Manifest} for details on the format and semantics of this file. Supported git protocols are \cb{git://}, \cb{http://}, and \cb{https://} for remote repositories and \cb{file://} for local repositories. While |