From 25ac900ad72e6fe15050228c45feed627c42495a Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 29 Mar 2018 16:28:21 +0200 Subject: [PATCH] CODING_STYLE: document suggested suffixes to use in documentation --- doc/CODING_STYLE | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/CODING_STYLE b/doc/CODING_STYLE index 7025d242fa..be30359160 100644 --- a/doc/CODING_STYLE +++ b/doc/CODING_STYLE @@ -454,3 +454,15 @@ O_NONBLOCK has a benefit: it bypasses any mandatory lock that might be in effect on the regular file. If in doubt consider turning off O_NONBLOCK again after opening. + +- When referring to a configuration file option in the documentation and such, + please always suffix it with "=", to indicate that it is a configuration file + setting. + +- When referring to a command line option in the documentation and such, please + allways prefix with "--" or "-" (as appropriate), to indicate that it is a + command line option. + +- When referring to a file system path that is a directory, please always + suffix it with "/", to indicate that it is a directory, not a regular file + (or other file system object).