summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2019-04-12 16:22:16 +0200
committerLennart Poettering <lennart@poettering.net>2019-04-12 16:28:35 +0200
commit971dfffab83de424bc36a3c034aabb04075abd60 (patch)
treee771e802a6b6449c8f90461077e89400c3dc652f /docs
parent8c9289e705f5a046124e13ccaa6856fd2db9d5bf (diff)
downloadsystemd-971dfffab83de424bc36a3c034aabb04075abd60.tar.gz
CODING_STYLE: add section about how to reference specific concepts
Diffstat (limited to 'docs')
-rw-r--r--docs/CODING_STYLE.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md
index ed87ae07cc..2c85485fa2 100644
--- a/docs/CODING_STYLE.md
+++ b/docs/CODING_STYLE.md
@@ -475,6 +475,8 @@ title: Coding Style
effect on the regular file. If in doubt consider turning off `O_NONBLOCK` again
after opening.
+## Referencing Concepts
+
- 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.