aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2018-08-04 11:26:39 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2018-08-04 11:26:39 +0200
commit7a3bb87c283da926b6f3433ddb9a4ccd7134ea24 (patch)
treee98c3eeb8ffb770eb8bb930bebd1703d077e6975
parent2b50a336cac49bd3984e6b36c94a1e93c55557d9 (diff)
Specify package manifest header
-rw-r--r--doc/manual.cli9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/manual.cli b/doc/manual.cli
index b6b6f3d..eff7a84 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -510,6 +510,12 @@ directory) describes a \c{bpkg} package. The manifest synopsis is presented
next followed by the detailed description of each value in subsequent
sections.
+The subset of the values up to and including \c{license} constitute the
+package manifest header. Note that the header is a valid package manifest
+since all the other values are optional. There is also no requirement for the
+header values to appear first or to be in a specific order. In particular, in
+a full package manifest they can be interleaved with non-header values.
+
\
name: <name>
version: <version>
@@ -517,6 +523,9 @@ version: <version>
[priority]: <priority> [; <comment>]
summary: <text>
license: <licenses> [; <comment>]
+\
+
+\
[tags]: <tags>
[description]: <text>
[description-file]: <path> [; <comment>]