summaryrefslogtreecommitdiff
path: root/doc/HACKING
diff options
context:
space:
mode:
authorjuga0 <juga@riseup.net>2018-06-11 21:29:40 +0000
committerjuga0 <juga@riseup.net>2018-06-11 21:29:40 +0000
commitcc09ff253e2516ea3bc4bdd7fa8c6052b36900e6 (patch)
treef35e44f2c7cf2beaf2d5b2bacdeca2a84ab0e05a /doc/HACKING
parent9b5b8e5bad550ded361948d457b230821f47681f (diff)
downloadtor-cc09ff253e2516ea3bc4bdd7fa8c6052b36900e6.tar.gz
tor-cc09ff253e2516ea3bc4bdd7fa8c6052b36900e6.zip
Add explanation about editorconf in coding standards
so that developers know what is .editorconfig for.
Diffstat (limited to 'doc/HACKING')
-rw-r--r--doc/HACKING/CodingStandards.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md
index 3711f70198..4a8f13716b 100644
--- a/doc/HACKING/CodingStandards.md
+++ b/doc/HACKING/CodingStandards.md
@@ -185,6 +185,9 @@ deviations from our C whitespace style. Generally, we use:
`puts (x)`.
- Function declarations at the start of the line.
+If you use an editor that has plugins for editorconfig.org, the file
+`.editorconfig` will help you to conform this coding style.
+
We try hard to build without warnings everywhere. In particular, if
you're using gcc, you should invoke the configure script with the
option `--enable-fatal-warnings`. This will tell the compiler