From ed88a5f7fe908c391a1552ac9dc5aeabb4ee85ef Mon Sep 17 00:00:00 2001 From: Thomas Fetzer <thomas.fetzer@iws.uni-stuttgart.de> Date: Mon, 27 Feb 2017 20:26:08 +0100 Subject: [PATCH] [handbook] Update text --- doc/handbook/4_developingdumux.tex | 28 ++++++++++++---------------- doc/handbook/5_grids.tex | 2 +- 2 files changed, 13 insertions(+), 17 deletions(-) diff --git a/doc/handbook/4_developingdumux.tex b/doc/handbook/4_developingdumux.tex index 4232a69197..e5c02ee1cb 100644 --- a/doc/handbook/4_developingdumux.tex +++ b/doc/handbook/4_developingdumux.tex @@ -3,19 +3,20 @@ \subsection{Communicate with \Dumux Developers} -\paragraph{GitLab Issues} -The bug-tracking system \emph{GitLab Issues} offers the possibility to report bugs or -discuss new development requests. Feel free to register (if you don't have a \emph{Git} account alreay) and to constribute +\paragraph{Issues and Bug Tracking} +The bug-tracking system \emph{GitLab Issues} offers the possibility to report bugs or discuss new development requests. +Feel free to register (if you don't have a \emph{Git} account already) and to constribute at \url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/issues}. -\paragraph{Flyspray} -The bug-tracking system \emph{Flyspray} has been replaced by \emph{GitLab Issues} and will not -be used anymore. +\paragraph{Commits, Merges, etc.} +To be up-to-date with the latest changes made to any git-repository you can use RSS Feeds. +Simply click on \emph{Issues} or \emph{Activity} and then select a tab you are interested in +and use your favorite RSS-application for receiving the news. \paragraph{Automatic Testing Dashboard} The automatic testing using \emph{BuildBot} helps to constantly check the \Dumux problems for compiling and running correctly. It is available at -\url{http://www.dumux.org/dashboard.php}. +\url{https://git.iws.uni-stuttgart.de/buildbot/#/builders}. \paragraph{The General Mailing List:} If you have questions, specific problems (which you really struggle to solve on your own), @@ -24,11 +25,6 @@ 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. -\paragraph{The Commit Mailing List:} -If you want to be informed about \Dumux-commits you can subscribe to the mailing list: -\url{https://listserv.uni-stuttgart.de/mailman/listinfo/dumux-commits}. - - \subsection{Tips and Tricks} \Dumux users and developers at the LH2 are also referred to the internal Wiki for more information. @@ -98,10 +94,10 @@ Dune::dinfo << "message"; // will NOT be printed \end{lstlisting} \paragraph{Make headercheck:} -To check one header file for all necessary includes to compile the contained -code, use \texttt{make headercheck}. 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. +To check one header file for all necessary includes to compile the contained code, use \texttt{make headercheck}. +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}. diff --git a/doc/handbook/5_grids.tex b/doc/handbook/5_grids.tex index 9e4fd4161a..b63b7f9cd4 100644 --- a/doc/handbook/5_grids.tex +++ b/doc/handbook/5_grids.tex @@ -8,7 +8,7 @@ construction of a structured grid is fairly easy. We will subsequently introduce and briefly mention how to customize and deal with common other grid formats. \subsection{Supported file formats} -\Dumux can read grids from file using the Dune Grid Format (DGF) or the Gmsh mesh format (only unstructured grids). +\Dumux can read grids from file using the Dune Grid Format (DGF) or the Gmsh mesh format. \subsubsection{Dune Grid Format} Most of our \Dumux tests and tutorials use the Dune Grid Format (DGF) to read in grids. A detailed description -- GitLab