Author: bugman
Date: Wed Oct 4 07:11:26 2006
New Revision: 2599
URL: http://svn.gna.org/viewcvs/relax?rev=2599&view=rev
Log:
Changed all references to Sconstruct in the manual to SCons. The program is
really called SCons!
Modified:
1.2/docs/latex/develop.tex
1.2/docs/latex/infrastruct.tex
Modified: 1.2/docs/latex/develop.tex
URL:
http://svn.gna.org/viewcvs/relax/1.2/docs/latex/develop.tex?rev=2599&r1=2598&r2=2599&view=diff
==============================================================================
--- 1.2/docs/latex/develop.tex (original)
+++ 1.2/docs/latex/develop.tex Wed Oct 4 07:11:26 2006
@@ -244,20 +244,20 @@
-% The Sconstruct build system.
+% The SCons build system.
%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-\section{The Sconstruct build system}
-
-\index{Sconstruct|textbf}
-The Sconstruct build system was chosen over other build systems including
\texttt{`make'}\index{make} as it is a cross-platform build system which can
be used in Unix\index{Unix}, GNU/Linux\index{GNU/Linux}, Mac OS X\index{Mac
OS X}, and even MS Windows\index{MS Windows} (the correct compilers are
nevertheless required). Various components of the program relax can be
created using the Sconstruct utility. This includes C module compilation,
manual creation, distribution creation, and cleaning up and removing certain
files. The file `sconstruct' in the base relax directory, which consists of
python code, directs the operation of Sconstruct for the various functions.
+\section{The SCons build system}
+
+\index{SCons|textbf}
+The SCons build system was chosen over other build systems including
\texttt{`make'}\index{make} as it is a cross-platform build system which can
be used in Unix\index{Unix}, GNU/Linux\index{GNU/Linux}, Mac OS X\index{Mac
OS X}, and even MS Windows\index{MS Windows} (the correct compilers are
nevertheless required). Various components of the program relax can be
created using the SCons utility. This includes C module compilation, manual
creation, distribution creation, and cleaning up and removing certain files.
The file `sconstruct' in the base relax directory, which consists of python
code, directs the operation of SCons for the various functions.
% C module compilation.
\subsection{C module compilation}
\index{C module compilation|textbf}
-\index{Sconstruct!C module compilation|textbf}
+\index{SCons!C module compilation|textbf}
As described in the installation chapter typing \texttt{`scons'} in the base
directory will create the shared objects which are imported into Python as
modules.
@@ -270,9 +270,9 @@
To create the PDF version of the relax manual type
\example{\$ scons manual}
-\index{Sconstruct!PDF manual|textbf}
-
-in the base directory. Sconstruct will then run a series of shell commands
to create the manual from the \LaTeX\ sources located in the
\texttt{`docs/latex'} directory. This is dependent on the programs
\texttt{`latex'}, \texttt{`makeindex'}, \texttt{`dvips'}, and
\texttt{`ps2pdf'} being located within the environment's path.
+\index{SCons!PDF manual|textbf}
+
+in the base directory. SCons will then run a series of shell commands to
create the manual from the \LaTeX\ sources located in the
\texttt{`docs/latex'} directory. This is dependent on the programs
\texttt{`latex'}, \texttt{`makeindex'}, \texttt{`dvips'}, and
\texttt{`ps2pdf'} being located within the environment's path.
@@ -283,7 +283,7 @@
The HTML version of the relax manual is made by typing
\example{\$ scons manual\_html}
-\index{Sconstruct!HTML manual|textbf}
+\index{SCons!HTML manual|textbf}
in the base directory. One command calling the program
\texttt{`latex2html'} will be executed which will create HTML pages from the
\LaTeX\ sources.
@@ -296,12 +296,12 @@
Two types of distribution archive can be created from the currently checked
out sources -- the source and binary distributions. To create the source
distribution type
\example{\$ scons source\_dist}
-\index{Sconstruct!source distribution|textbf}
+\index{SCons!source distribution|textbf}
whereas to create the binary distribution, whereby the C modules are
compiled and the resultant shared objects are included in the bzipped tar
file, type
\example{\$ scons binary\_dist}
-\index{Sconstruct!binary distribution|textbf}
+\index{SCons!binary distribution|textbf}
If a binary distribution does not exist for your architecture feel free to
create it yourself and contribute the archive to be included on the download
pages. To do this you will need to check out the appropriate tagged branch
from the relax subversion repository. If the current stable release is
called 1.2.3 check out that branch by typing
@@ -324,7 +324,7 @@
If the command
\example{\$ scons clean}
-\index{Sconstruct!clean up|textbf}
+\index{SCons!clean up|textbf}
is run in the base directory all Python byte compiled files
\texttt{`*.pyc'}, all C object files \texttt{`*.o'} and \texttt{`*.os'}, all
C shared object files \texttt{`*.so'}, and any backup files with the
extension \texttt{`*.bak'} are removed from all sub-directories. In addition
any temporary \LaTeX\ compilation files are removed from the
\texttt{`docs/latex'} directory.
Modified: 1.2/docs/latex/infrastruct.tex
URL:
http://svn.gna.org/viewcvs/relax/1.2/docs/latex/infrastruct.tex?rev=2599&r1=2598&r2=2599&view=diff
==============================================================================
--- 1.2/docs/latex/infrastruct.tex (original)
+++ 1.2/docs/latex/infrastruct.tex Wed Oct 4 07:11:26 2006
@@ -103,6 +103,6 @@
\$ cd relax \\
\$ scons binary\_dist
\end{exampleenv}
-\index{Sconstruct!binary distribution}
+\index{SCons!binary distribution}
-At the end Sconstruct\index{Sconstruct} will attempt to make a GPG
signature\index{GPG!signature} for the newly created archive. However this
will fail as the current relax private GPG key\index{GPG!key} is not
available for security reasons. If the Sconstruct command fails, excluding
the GPG signing, please submit a bug report\index{bug tracker} with as much
information possible including the details described next to
\href{https://gna.org/bugs/?group=relax\&func=additem}{https://gna.org/bugs/?group=relax\&func=additem}
(the python and Sconstruct version numbers may also be useful). Once the
file has been created post a message to the relax development mailing
list\index{mailing list!relax-devel} describing the compilation and the
creation of the archive, the relax version number, the machine architecture,
operating system, and the name of the new file. Do not attach the file
though. You will then receive a response explaining where to send the file
to. For security the archive will be thoroughly checked and if the source
code is identical to that in the repository and the C modules are okay, the
file will be GPG signed\index{GPG!signature} and uploaded to
\href{http://download.gna.org/relax/}{http://download.gna.org/relax/}.
+At the end SCons\index{SCons} will attempt to make a GPG
signature\index{GPG!signature} for the newly created archive. However this
will fail as the current relax private GPG key\index{GPG!key} is not
available for security reasons. If the SCons command fails, excluding the
GPG signing, please submit a bug report\index{bug tracker} with as much
information possible including the details described next to
\href{https://gna.org/bugs/?group=relax\&func=additem}{https://gna.org/bugs/?group=relax\&func=additem}
(the python and SCons version numbers may also be useful). Once the file
has been created post a message to the relax development mailing
list\index{mailing list!relax-devel} describing the compilation and the
creation of the archive, the relax version number, the machine architecture,
operating system, and the name of the new file. Do not attach the file
though. You will then receive a response explaining where to send the file
to. For security the archive will be thoroughly checked and if the source
code is identical to that in the repository and the C modules are okay, the
file will be GPG signed\index{GPG!signature} and uploaded to
\href{http://download.gna.org/relax/}{http://download.gna.org/relax/}.
r2599 - in /1.2/docs/latex: develop.tex infrastruct.tex