diff --git a/doc/handbook/0_dumux-handbook.tex b/doc/handbook/0_dumux-handbook.tex index 0a2416b866fa6490e81cffb4fc34f1439d5ba11e..e2ad5962240d95a8531a807751b66cefc8af36a0 100644 --- a/doc/handbook/0_dumux-handbook.tex +++ b/doc/handbook/0_dumux-handbook.tex @@ -126,14 +126,13 @@ how to build the documentation and about external libraries and modules. \chapter{Overview and Infrastructure} This chapter provides an overview of the general structure in \Dumux \ref{sc_structure} and gives help for basic work with \Dumux -(\ref{sc_newfoldersetup},\ref{sc_parameterfiles},\ref{sc_restartsimulations},\ref{sc_guidelines},\ref{sc_developingdumux}). +(\ref{sc_newfoldersetup},\ref{sc_parameterfiles},\ref{sc_restartsimulations}, \ref{sc_developingdumux}). Further it presents useful external tools \ref{sc_externaltools} and basic concepts \ref{sc_linearsystem}. \input{4_structure} \input{4_newfoldersetup} \input{4_parameterfiles} \input{4_restartsimulations} -\input{4_guidelines} \input{4_developingdumux} \input{4_externaltools} \input{4_assemblinglinearsystem} diff --git a/doc/handbook/4_developingdumux.tex b/doc/handbook/4_developingdumux.tex index e5c02ee1cbc6174a20b4d876f7b8d02aed99365b..8b97737db18c1f1b470c674b0f378d8b6d6d1028 100644 --- a/doc/handbook/4_developingdumux.tex +++ b/doc/handbook/4_developingdumux.tex @@ -25,6 +25,13 @@ You can subscribe to the mailing list via \url{https://listserv.uni-stuttgart.de/mailman/listinfo/dumux}, then you will be informed about upcoming releases or events. +\subsection{Coding Guidelines} +Writing code in a readable manner is very important, especially +for future code developers (e.g. for adding features, debugging, etc.). +For the style guide and instructions how to contribute to \Dumux visit +\url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/blob/master/CONTRIBUTING.md}. + + \subsection{Tips and Tricks} \Dumux users and developers at the LH2 are also referred to the internal Wiki for more information. @@ -98,9 +105,3 @@ To check one header file for all necessary includes to compile the contained cod Include the option \texttt{-DENABLE\_HEADERCHECK=1} in your opts file and run \texttt{dunecontrol}. Then go to the top level in your build-directory and type \texttt{make headercheck} to check all headers or press 'tab' to use the auto-completion to search for a specific header. - -\paragraph{Naming conventions} -General guidelines for naming conventions are specified in Section \ref{sc_guidelines}. -However, in order to avoid ambiguity a list of proposed names for variables, types, -functions etc is provided where users and mainly \Dumux developers can refer for -standards (check \texttt{dumux-devel/\allowbreak doc/\allowbreak naminglist/\allowbreak naming-conventions.odt}). diff --git a/doc/handbook/4_guidelines.tex b/doc/handbook/4_guidelines.tex deleted file mode 100644 index a815a27197c9c883826c1b7460c2b729db45d3b0..0000000000000000000000000000000000000000 --- a/doc/handbook/4_guidelines.tex +++ /dev/null @@ -1,6 +0,0 @@ -\section{Coding Guidelines} -\label{sc_guidelines} -Writing code in a readable manner is very important, especially -for future code developers (e.g. for adding features, debugging, etc.). -For the style guide and instructions how to contribute to \Dumux visit -\url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/blob/master/CONTRIBUTING.md}.