summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-04-05 14:14:45 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-04-12 08:37:41 +0200
commit3b69b18fbfc8dd5599bdb2d4654644a341046e3e (patch)
treeb331a62c4109b814e3c5d72bc10ab3916de3984d /docs
parentshell-completion/zsh: add -*type*- headers (diff)
downloadsystemd-3b69b18fbfc8dd5599bdb2d4654644a341046e3e.tar.xz
systemd-3b69b18fbfc8dd5599bdb2d4654644a341046e3e.zip
CODING_STYLE: adjust indentation rules, and add note about config loading
Diffstat (limited to 'docs')
-rw-r--r--docs/CODING_STYLE.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md
index 7bad3f5d2e..71642bdf9b 100644
--- a/docs/CODING_STYLE.md
+++ b/docs/CODING_STYLE.md
@@ -4,8 +4,8 @@ title: Coding Style
# Coding Style
-- 8ch indent, no tabs, except for files in `man/` which are 2ch indent,
- and still no tabs.
+- 8ch indent, no tabs, except for files in `man/` which are 2ch indent, and
+ still no tabs, and shell scripts, which are 4ch indent, and no tabs either.
- We prefer `/* comments */` over `// comments` in code you commit, please. This
way `// comments` are left for developers to use for local, temporary
@@ -17,7 +17,9 @@ title: Coding Style
all of today's screens should be much larger than that. But then again, don't
overdo it, ~109ch should be enough really. The `.editorconfig`, `.vimrc` and
`.dir-locals.el` files contained in the repository will set this limit up for
- you automatically, if you let them (as well as a few other things).
+ you automatically, if you let them (as well as a few other things). Please
+ note that emacs loads `.dir-locals.el` automatically, but vim needs to be
+ configured to load `.vimrc`, see that file for instructions.
- Variables and functions **must** be static, unless they have a
prototype, and are supposed to be exported.