From: kanschat Date: Mon, 15 Apr 2013 13:25:31 +0000 (+0000) Subject: notes on indentation X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=565255832f9781ce8c395662c3383cffacd5ff57;p=dealii-svn.git notes on indentation git-svn-id: https://svn.dealii.org/trunk@29277 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/doc/development/indentation.html b/deal.II/doc/development/indentation.html new file mode 100644 index 0000000000..136881c130 --- /dev/null +++ b/deal.II/doc/development/indentation.html @@ -0,0 +1,42 @@ + + + + deal.II indentation + + + + + + + + + +

Notes on deal.II indentation

+ +

deal.II uses astyle to normalize indentation. A + style file is provided at + + DEAL/contrib/utilities/astyle.rc + + where DEAL is the path to you deal.II source directory.

+ +

All header and source files in the SVN repository are supposed + to conform to this style file. It is very important that we adhere + to this indentation style in order to avoid false conflicts on svn + updates.

+ +

Before every commit, you should run + + astyle --options=DEAL/contrib/utilities/astyle.rc + + on each of your files. This will make sure indentation is + conforming to our style.

+ +

Upon commit, svn will output comments on the conformity of your files. If you see a line of the form + + !! file style mismatch detected + + please re-indent the file. SVN may reject those files soon!

+ +