From: Martin Wilck <mwilck@suse.com>
To: Christophe Varoqui <christophe.varoqui@opensvc.com>
Cc: Xose Vazquez Perez <xose.vazquez@gmail.com>,
dm-devel@redhat.com, Martin Wilck <mwilck@suse.com>
Subject: [PATCH 6/6] multipath.conf(5): improve syntax documentation
Date: Tue, 6 Mar 2018 23:56:33 +0100 [thread overview]
Message-ID: <20180306225633.12028-7-mwilck@suse.com> (raw)
In-Reply-To: <20180306225633.12028-1-mwilck@suse.com>
Describe the syntax of attribute / value pairs, comments, and quoted
strings, as well as the peculiarities of section beginnings and ends.
Also describe the newly added '""' feature.
Signed-off-by: Martin Wilck <mwilck@suse.com>
---
multipath/multipath.conf.5 | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/multipath/multipath.conf.5 b/multipath/multipath.conf.5
index ab151e720d75..c4d0789475a3 100644
--- a/multipath/multipath.conf.5
+++ b/multipath/multipath.conf.5
@@ -67,6 +67,23 @@ recognized keywords for attributes or subsections depend on the
section in which they occur.
.LP
.
+\fB<attribute>\fR and \fB<value>\fR must be on a single line.
+\fB<attribute>\fR is one of the keywords listed in this man page.
+\fB<value>\fR is either a simple word (containing no whitespace and none of the
+characters '\(dq', '#', and '!') or \fIone\fR string enclosed in double
+quotes ("..."). Outside a quoted string, text starting with '#', and '!' is
+regarded as a comment and ignored until the end of the line. Inside a quoted
+string, '#' and '!' are normal characters, and whitespace is preserved.
+To represent a double quote character inside a double quoted string, use two
+consecutive double quotes ('""'). Thus '2.5\(dq SSD' can be written as "2.5"" SSD".
+.LP
+.
+Opening braces ('{') must follow the (sub)section name on the same line. Closing
+braces ('}') that mark the end of a (sub)section must be the only non-whitespace
+character on the line. Whitespace is ignored except inside double quotes, thus
+the indentation shown in the above example is helpful for human readers but
+not mandatory.
+.LP
.
The following \fIsection\fP keywords are recognized:
.TP 17
--
2.16.1
next prev parent reply other threads:[~2018-03-06 22:56 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-06 22:56 [PATCH 0/6] Fixes for config file parsing Martin Wilck
2018-03-06 22:56 ` [PATCH 1/6] tests/uevent: fix -Wcast-qual errors Martin Wilck
2018-03-06 22:56 ` [PATCH 2/6] tests: add unit tests for config file parser Martin Wilck
2018-03-06 22:56 ` [PATCH 3/6] libmultipath: config parser: don't strip whitepace between quotes Martin Wilck
2018-03-06 22:56 ` [PATCH 4/6] libmultipath: config parser: Allow '"' in strings Martin Wilck
2018-03-06 22:56 ` [PATCH 5/6] libmultipath: config parser: fix corner case for double quotes Martin Wilck
2018-03-06 22:56 ` Martin Wilck [this message]
2018-03-06 23:06 ` [PATCH 0/6] Fixes for config file parsing Martin Wilck
2018-03-07 18:25 ` Martin Wilck
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180306225633.12028-7-mwilck@suse.com \
--to=mwilck@suse.com \
--cc=christophe.varoqui@opensvc.com \
--cc=dm-devel@redhat.com \
--cc=xose.vazquez@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).