aboutsummaryrefslogtreecommitdiff
path: root/doc/developer-notes.md
diff options
context:
space:
mode:
authorMarcoFalke <falke.marco@gmail.com>2017-01-28 16:58:29 +0100
committerMarcoFalke <falke.marco@gmail.com>2017-01-28 16:57:08 +0100
commitfa5137c11d2d4accd9bfc68b3498e7e16829c3ab (patch)
treea712302f90b56aef5f25ce086c10f1dd645f2fb1 /doc/developer-notes.md
parenta7ea2f8fdbe9392bcbd4a219a42ebd9518d2e2ef (diff)
[doc] Remove unused clang format dev script
Also, update the clang format file to reflect the current coding style mentioned in the developer notes.
Diffstat (limited to 'doc/developer-notes.md')
-rw-r--r--doc/developer-notes.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index f8c34e060f..989ad8d03e 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -4,10 +4,11 @@ Developer Notes
Various coding styles have been used during the history of the codebase,
and the result is not very consistent. However, we're now trying to converge to
a single style, so please use it in new code. Old code will be converted
-gradually.
+gradually and you are encouraged to use the provided
+[clang-format-diff script](/contrib/devtools/README.md#clang-format-diffpy)
+to clean up the patch automatically before submitting a pull request.
+
- Basic rules specified in [src/.clang-format](/src/.clang-format).
- Use a recent clang-format to format automatically using one of the [dev scripts]
- (/contrib/devtools/README.md#clang-formatpy).
- Braces on new lines for namespaces, classes, functions, methods.
- Braces on the same line for everything else.
- 4 space indentation (no tabs) for every block except namespaces.