From e253cd97c6a8d55a5be19731d58769f4663ab2d1 Mon Sep 17 00:00:00 2001
From: Karen Arutyunov <karen@codesynthesis.com>
Date: Wed, 6 Oct 2021 22:16:46 +0300
Subject: Add support for applying backward compatibility workarounds to
 packages.manifest file generated by rep-create

---
 doc/manual.cli | 45 +++++++++++++++++++++++++++++++++++++++------
 1 file changed, 39 insertions(+), 6 deletions(-)

(limited to 'doc')

diff --git a/doc/manual.cli b/doc/manual.cli
index cbca17d..86fe17f 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -1772,12 +1772,12 @@ The repository fragment id this repository belongs to.
 terminology and semantics.
 
 The repository list manifest (the \c{repositories.manifest} file found in the
-repository root directory) describes the repository. It is a sequence of
-repository manifests consisting of the base repository manifest (that is, the
-manifest for the repository that is being described) as well as manifests for
-its prerequisite and complement repositories. The individual repository
-manifests can appear in any order and the base repository manifest can be
-omitted.
+repository root directory) describes the repository. It starts with an
+optional header manifest optionally followed by a sequence of repository
+manifests consisting of the base repository manifest (that is, the manifest
+for the repository that is being described) as well as manifests for its
+prerequisite and complement repositories. The individual repository manifests
+can appear in any order and the base repository manifest can be omitted.
 
 The \c{fragment} values can only be present in a merged
 \c{repositories.manifest} file for a multi-fragment repository.
@@ -1789,6 +1789,8 @@ repository could look like this:
 # math/testing
 #
 : 1
+min-bpkg-version: 0.14.0
+:
 email: math-pkg@example.org
 summary: Math package repository
 :
@@ -1814,6 +1816,37 @@ Then the completement's location would be:
 https://pkg.example.org/1/math/stable
 \
 
+The header manifest synopsis is presented next followed by the detailed
+description of each value in subsequent sections.
+
+\
+[min-bpkg-version]: <ver>
+[compression]: <compressions>
+\
+
+\h2#manifest-repository-list-header-min-bpkg-version|\c{min-bpkg-version}|
+
+\
+[min-bpkg-version]: <ver>
+\
+
+The earliest version of \cb{bpkg} that is compatible with this repository.
+Note that if specified, it must be the first value in the header.
+
+
+\h2#manifest-repository-list-header-compression|\c{compression}|
+
+\
+[compression]: <compressions>
+
+<compressions> = <compression> [ <compression>]*
+\
+
+Available compressed variants of the \c{packages.manifest} file. The format is
+a space-separated list of the compression methods. The \c{none} method means
+no compression. Absent \c{compression} value is equivalent to specifying it
+with the \c{none} value.
+
 
 \h#manifest-signature-pkg|Signature Manifest for \cb{pkg} Repositories|
 
-- 
cgit v1.1