From ada2581d82e4b14ec6faaae9ca8af44ad2175447 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Thu, 23 Jun 2022 12:51:04 +0200 Subject: Document new multi-line manifest value with comment semantics --- doc/manual.cli | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) 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: -- cgit v1.1