aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2022-06-23 12:51:04 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2022-06-23 12:51:04 +0200
commitada2581d82e4b14ec6faaae9ca8af44ad2175447 (patch)
treed8dae5408a24e385b4940cd3c881484ffd672c69
parentc0ca17391c41048cd1db19f0aa08e060624f4bd1 (diff)
Document new multi-line manifest value with comment semantics
-rw-r--r--doc/manual.cli29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/manual.cli b/doc/manual.cli
index ec0a535..117891e 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -539,6 +539,35 @@ example:
url: http://git.example.com/?p=foo\;a=tree
\
+The only other recognized escape sequence in such values is \c{\\\\}, which is
+replaced with a single backslash. If a backslash is followed by any other
+character, then it is treated literally.
+
+If a value with a comment is multi-line, then \c{;} must appear on a separate
+line, for example:
+
+\
+url:\
+http://git.example.com/?p=foo;a=tree
+;
+Git repository tree.
+\\
+\
+
+In this case, only lines that consist of a sole non-comment semicolon need
+escaping, for example:
+
+\
+license:\
+other: strange
+\;
+license
+\\
+\
+
+The only other recognized escape sequence in such multi-line values is lines
+consisting of two or more backslashes followed by a semicolon.
+
In the manifest specifications described below optional components are
enclosed in square brackets (\c{[]}). If the name is enclosed in \c{[]} then
the name-value pair is optional, otherwise \- required. For example: