From: Niklas Fehn Date: Tue, 15 Mar 2022 18:09:37 +0000 (+0100) Subject: remove notes on indentation from documentation X-Git-Tag: v9.4.0-rc1~287^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a32198de88919b882ee55c7a03b951f163af6caa;p=dealii.git remove notes on indentation from documentation --- diff --git a/doc/doxygen/headers/coding_conventions.h b/doc/doxygen/headers/coding_conventions.h index 128f14060b..4b31dc90ee 100644 --- a/doc/doxygen/headers/coding_conventions.h +++ b/doc/doxygen/headers/coding_conventions.h @@ -30,42 +30,6 @@ before output arguments of a function call. They also simplify reading code because some things become clear already by looking at the style a piece of code is written, without having to look up the exact definition of something. -

Notes on deal.II indentation

- -

deal.II uses clang-format 11.1 to normalize indentation. A -style file is provided at -@code - \${SOURCE_DIR}/.clang-format -@endcode - -

Before a commit, you should run -@code - clang-format -i -@endcode -on each of your files. This will make sure indentation is conforming to the -style guidelines outlined in this page. - -This is cumbersome. Consequently, and more easily, you can just run -@code - make indent -@endcode -in whatever directory you set up the library to be compiled in, to indent all -source files that have been changed recently. If you want to make sure that -the indenting is correct for all your commits, you might want to set up a -pre-commit hook. One way to do so, is to copy -\${SOURCE_DIR}/contrib/git-hooks/pre-commit to -\${SOURCE_DIR}/.git/hooks/pre-commit and make sure it is -executable. - -If the system you are working on has more than one version of -clang-format installed (or if it is not in the path) -you should replace the above make indent command with -@code - make DEAL_II_CLANG_FORMAT=/path/to/clang-11.1/clang-format indent -@endcode -to point to the correct executable. -

-

Style issues