]> https://gitweb.dealii.org/ - dealii.git/commitdiff
remove notes on indentation from documentation
authorNiklas Fehn <fehn@lnm.mw.tum.de>
Tue, 15 Mar 2022 18:09:37 +0000 (19:09 +0100)
committerNiklas Fehn <fehn@lnm.mw.tum.de>
Sun, 24 Apr 2022 13:38:06 +0000 (15:38 +0200)
doc/doxygen/headers/coding_conventions.h

index 128f14060b43f5e0085d09b8196ac764ead68bc4..4b31dc90eec9c5f5c4126638fff3778d34a95b43 100644 (file)
@@ -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.
 
-<h3>Notes on deal.II indentation</h3>
-
-<p>deal.II uses <code>clang-format</code> 11.1 to normalize indentation. A
-style file is provided at
-@code
-  \${SOURCE_DIR}/.clang-format
-@endcode
-
-<p>Before a commit, you should run
-@code
-  clang-format -i <file>
-@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
-<code>\${SOURCE_DIR}/contrib/git-hooks/pre-commit</code> to
-<code>\${SOURCE_DIR}/.git/hooks/pre-commit</code> and make sure it is
-executable.
-
-If the system you are working on has more than one version of
-<code>clang-format</code> installed (or if it is not in the path)
-you should replace the above <code>make indent</code> command with
-@code
-  make DEAL_II_CLANG_FORMAT=/path/to/clang-11.1/clang-format indent
-@endcode
-to point to the correct executable.
-</p>
-
 <h3>Style issues</h3>
 
 <ol>

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.