From 2d2f8abcb713638b70f46539ee0bc0bd39497668 Mon Sep 17 00:00:00 2001
From: sbrandt <sbrandt@17b73243-c579-4c4c-a9d2-2d5706c11dac>
Date: Wed, 23 Oct 2013 20:06:11 +0000
Subject: Update for ticket #652, CACTUS_CONFIGS_DIR documentation.

git-svn-id: http://svn.cactuscode.org/flesh/trunk@5048 17b73243-c579-4c4c-a9d2-2d5706c11dac
---
 doc/UsersGuide.pdf       | Bin 716732 -> 718199 bytes
 doc/UsersGuide/Notes.tex |  16 +++++++++++++++-
 2 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/doc/UsersGuide.pdf b/doc/UsersGuide.pdf
index e486d2ce..5095d057 100644
Binary files a/doc/UsersGuide.pdf and b/doc/UsersGuide.pdf differ
diff --git a/doc/UsersGuide/Notes.tex b/doc/UsersGuide/Notes.tex
index 4121184f..7cb14c7e 100644
--- a/doc/UsersGuide/Notes.tex
+++ b/doc/UsersGuide/Notes.tex
@@ -297,6 +297,14 @@ for and to preprocess Fortran code.
 \item [\texttt{PERL}]   The name of the Perl executable.
 \end{Lentry}
 
+\item {Output Directory}
+
+By default, Cactus generates intermediate and object files
+underneath a directory named ``configs'' inside the Cactus
+directory. This location may be changed through the use
+of the \texttt{CACTUS\_CONFIGS\_DIR} environment variable.
+See the section on File Layout~\ref{file_layout}.
+
 \item {Compilation and tool flags}
 
 Flags which are passed to the compilers and the tools.
@@ -787,9 +795,15 @@ preprocessor defines necessary for compiling multithreaded code.
 
 
 \section{File Layout}
+\label{file_layout}
 
 The configuration process sets up various subdirectories and files in the
-\texttt{configs} directory to contain the configuration specific files; these
+configuration
+directory (this is either a directory
+\texttt{configs} insde the main Cactus directory, or the
+directory pointed to by the \texttt{CACTUS\_CONFIGS\_DIR} environment
+variable).
+to contain the configuration specific files; these
 are placed in a directory with the name of the configuration.
 
 \begin{Lentry}
-- 
cgit v1.2.3