mirror of
https://github.com/systemd/systemd
synced 2024-09-06 16:56:43 +00:00
CODING_STYLE: document suggested suffixes to use in documentation
This commit is contained in:
parent
46f8867372
commit
25ac900ad7
|
@ -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).
|
||||
|
|
Loading…
Reference in a new issue