aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2020-01-29 12:46:10 (GMT)
committerKaren Arutyunov <karen@codesynthesis.com>2020-01-29 13:24:54 (GMT)
commitd561b9fed787b4b20025210f00db981f25f1ae50 (patch)
tree392259715c30b9bc07226a1d5e46e722a42ec2e9
parentb6772764ff5e15b63df10c5a59e8926a3a404ab3 (diff)
Restrict manifest text with only Unicode graphic characters, '\t', '\r', and '\n'HEADmaster
-rw-r--r--doc/manual.cli9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/manual.cli b/doc/manual.cli
index 65e96c4..49afefd 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -311,8 +311,9 @@ of a repository, respectively.
\h#manifest-format|Manifest Format|
-The manifest format is a UTF-8 encoded text containing a list of name-value
-pairs in the form:
+A manifest is a UTF-8 encoded text restricted to the Unicode graphic
+characters, tabs (\c{\\t}), carriage returns (\c{\\r}), and line feeds
+(\c{\\n}). It contains a list of name-value pairs in the form:
\
<name>: <value>
@@ -325,6 +326,10 @@ name: libfoo
version: 1.2.3
\
+\N|If a value needs to be able to contain other Unicode codepoints, they
+should be escaped in a value-specific manner. For example, the backslash
+(\c{\\}) escaping described below can be extended for this purpose.|
+
The name can contain any characters except \c{:} and whitespaces. Newline
terminates the pair unless escaped with \c{\\} (see below). Leading and
trailing whitespaces before and after name and value are ignored except in the