From 05078427ba4fca84e7a14cf6edfdce6b8cc89766 Mon Sep 17 00:00:00 2001
From: Nicolas Schwenck <nicolas.schwenck@iws.uni-stuttgart.de>
Date: Thu, 24 Jan 2013 11:15:48 +0000
Subject: [PATCH] adapted the "setup a new folder" section -> review and
further input from Christoph required!
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@10082 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
doc/handbook/newFolder.tex | 26 ++++++++++++++++++++++++--
1 file changed, 24 insertions(+), 2 deletions(-)
diff --git a/doc/handbook/newFolder.tex b/doc/handbook/newFolder.tex
index dbe984179a..61b06df221 100644
--- a/doc/handbook/newFolder.tex
+++ b/doc/handbook/newFolder.tex
@@ -2,13 +2,13 @@
In this section setting up a new folder is described. In fact it is very easy to create a new folder, but getting \Dumux to know the new folder takes some steps which will be explained in more detail below:
-\begin{itemize}
+\begin{enumerate}
\item create new folder with content
\item adapt \verb+Makefile.am+
\item insert new folder in \verb+Makefile.am+ of the directory above
\item adapt \verb+configure.ac+ in the \verb+$DUMUX_ROOT+ (the directory you checked out, probably dumux)
\item newly compile \Dumux
-\end{itemize}
+\end{enumerate}
\noindent In more detail:
@@ -49,7 +49,29 @@ All occurrences of \verb+test_2p+ need to be replaced by the name of the new pro
\textbf{Fifth}: Compile \Dumux as described in Section \ref{install}.
+\paragraph{Committing a new folder to the svn repository}
+For those who work with svn and want to commit a newly setup folder to the repository, additional guidelines apply:
+
+\begin{enumerate}
+ \item use svn attributes to ignore files which are automatically created by a dunecontrol run
+ \item make headercheck
+ \item test doxygen
+\end{enumerate}
+
+\noindent In more detail:
+
+\textbf{First}: The command \verb+svn status+ marks all files not under version control with a question mark. Because dunecontrol creates a lot of files automatically this output becomes relatively crowded and one might overlook ``real'' files which have to be added (they also will not be shown by a \verb+svn status -q+).
+
+How to set the svn attributes:
+\begin{itemize}
+ \item[{\em eclipse}] right click on the file/folder $\rightarrow$ ``team'' $\rightarrow$ ``add to svn:ignore\dots''
+ \item[{\em kdesvn}] right click on the file/folder $\rightarrow$ ``ignore/unignore current item''
+ \item[{\em shell}] \verb+svn propset svn:ignore svnignoretest .+
+\end{itemize}
+Commit the changes for example in the command line with \verb+svn commit -m+ to the repository.
+\textbf{Second}:
+\textbf{Third}:
\ No newline at end of file
--
GitLab