From: Lennart Poettering <lennart@poettering.net>
Date: Thu, 29 Mar 2018 14:28:21 +0000 (+0200)
Subject: CODING_STYLE: document suggested suffixes to use in documentation
X-Git-Tag: v239~444^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F8643%2Fhead;p=thirdparty%2Fsystemd.git

CODING_STYLE: document suggested suffixes to use in documentation
---

diff --git a/doc/CODING_STYLE b/doc/CODING_STYLE
index 7025d242fa4..be303591605 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).