Author: bugman
Date: Wed Aug 29 11:03:26 2012
New Revision: 17376
URL: http://svn.gna.org/viewcvs/relax?rev=17376&view=rev
Log:
More chapter cross referencing in the relax user manual.
Modified:
trunk/docs/latex/develop.tex
trunk/docs/latex/infrastruct.tex
trunk/docs/latex/intro.tex
Modified: trunk/docs/latex/develop.tex
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/develop.tex?rev=17376&r1=17375&r2=17376&view=diff
==============================================================================
--- trunk/docs/latex/develop.tex (original)
+++ trunk/docs/latex/develop.tex Wed Aug 29 11:03:26 2012
@@ -1,7 +1,7 @@
% relax development.
%%%%%%%%%%%%%%%%%%%%
-\chapter{relax development}
+\chapter{relax development} \label{ch: relax devel}
This chapter is for developers or those who would like to extend the
functionality of relax. It is not required for using relax. If you would
like to make modifications to the relax source code please subscribe to all
the relax mailing lists\index{mailing list} (see the open source
infrastructure chapter for more details). Announcements are sent to
``relax-announce at gna.org''\index{mailing list!relax-announce} whereas
``relax-users at gna.org''\index{mailing list!relax-users} is the list where
discussions about the usage of relax should be posted. ``relax-devel at
gna.org''\index{mailing list!relax-devel} is where all discussions about the
development of relax including feature requests, program design, or any other
discussions relating to relax's structure or code should be posted. Finally,
``relax-commits at gna.org''\index{mailing list!relax-commits} is where all
changes to relax's code and documentation, as well as changes to the web
pages, are automatically sent to. Anyone interested in joining the project
should subscribe to all four lists.
@@ -12,7 +12,7 @@
\section{Version control using Subversion}\label{svn repository}
-The development of relax requires the use of the
Subversion\index{Subversion|textbf} (SVN)\index{SVN|textbf} version control
software downloadable from
\href{http://subversion.tigris.org/}{http://subversion.tigris.org/}. The
source code to relax is stored in an SVN repository located at
\href{http://svn.gna.org/svn/relax/}{http://svn.gna.org/svn/relax/}. Every
single change which has ever made to the program is recorded within this
repository\index{repository}. For more information see the open source
infrastructure chapter.
+The development of relax requires the use of the
Subversion\index{Subversion|textbf} (SVN)\index{SVN|textbf} version control
software downloadable from
\href{http://subversion.tigris.org/}{http://subversion.tigris.org/}. The
source code to relax is stored in an SVN repository located at
\href{http://svn.gna.org/svn/relax/}{http://svn.gna.org/svn/relax/}. Every
single change which has ever made to the program is recorded within this
repository\index{repository}. For more information see the open source
infrastructure chapter~\ref{ch: open source} on page~\pageref{ch: open
source}.
Although the downloadable distribution archives\index{distribution archive}
can be modified it is best that the most current and up to date revision (the
\textit{head} revision) is modified instead. More information about the
basics of version control and how this is implemented in Subversion can be
found in the Subversion book located at
\href{http://svnbook.red-bean.com/}{http://svnbook.red-bean.com/}.
@@ -593,7 +593,7 @@
\example{\$ svn co svn://svn.gna.org/svn/relax/tags/1.2.3 relax}
\index{Subversion!check out}
-Then build the binary distribution and send a message to the relax
development mailing list\index{mailing list!relax-devel}. If compilation
does not work please submit a bug to the bug tracker\index{bug tracker}
system at
\href{https://gna.org/bugs/?group=relax}{https://gna.org/bugs/?group=relax}
detailing the relax version, operation system, architecture, and any other
information you believe will help to solve the problem. More information
about donating binary distributions to the relax project is given in the open
source infrastructure chapter.
+Then build the binary distribution and send a message to the relax
development mailing list\index{mailing list!relax-devel}. If compilation
does not work please submit a bug to the bug tracker\index{bug tracker}
system at
\href{https://gna.org/bugs/?group=relax}{https://gna.org/bugs/?group=relax}
detailing the relax version, operation system, architecture, and any other
information you believe will help to solve the problem. More information
about donating binary distributions to the relax project is given in the open
source infrastructure chapter (Chapter~\ref{ch: open source},
page~\pageref{ch: open source}).
Modified: trunk/docs/latex/infrastruct.tex
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/infrastruct.tex?rev=17376&r1=17375&r2=17376&view=diff
==============================================================================
--- trunk/docs/latex/infrastruct.tex (original)
+++ trunk/docs/latex/infrastruct.tex Wed Aug 29 11:03:26 2012
@@ -1,7 +1,7 @@
% Open source infrastructure chapter.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\chapter{Open source infrastructure}
+\chapter{Open source infrastructure} \label{ch: open source}
@@ -67,7 +67,7 @@
When reporting a bug please include as much information as possible so that
the problem can be reproduced. Include information such as the release
version or the revision number if the repository sources are being used.
Also include all the steps performed in order to trigger the bug. Attachment
of files is allowed so scripts and subsets of the input data can be included.
However please do not attach large files to the report. Prior to reporting
the bug try to make sure that the problem is indeed a bug and if you have any
doubts please feel free to ask on the relax-users mailing list\index{mailing
list!relax-users}. To avoid duplicates be sure that the bug has not already
been submitted to the bug tracker\index{bug tracker}. You can search the
bugs\index{bug!search} from the page
\href{https://gna.org/project/search.php?group=relax}{https://gna.org/project/search.php?group=relax}.
-Once the bug has been confirmed by one of the relax developers you may speed
up the resolution of the problem by trying to fixing the bug yourself. If
you do wish to play with the source code and try to fix the issue see the
relax development chapter of this manual on how to check out the latest
sources, how to generate a patch (which is just the output of
diff\index{diff} in the `unified' format), and the guidelines for the format
of the code.
+Once the bug has been confirmed by one of the relax developers you may speed
up the resolution of the problem by trying to fixing the bug yourself. If
you do wish to play with the source code and try to fix the issue see the
relax development chapter of this manual on how to check out the latest
sources (Chapter~\ref{ch: relax devel} on page~\pageref{ch: relax devel}),
how to generate a patch (which is just the output of diff\index{diff} in the
`unified' format), and the guidelines for the format of the code.
Modified: trunk/docs/latex/intro.tex
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/intro.tex?rev=17376&r1=17375&r2=17376&view=diff
==============================================================================
--- trunk/docs/latex/intro.tex (original)
+++ trunk/docs/latex/intro.tex Wed Aug 29 11:03:26 2012
@@ -67,7 +67,7 @@
\item All other dynamics analyses.
\end{itemize}
-Because relax is free software, if you would like to contribute addition
features, functions, or modules which you have written for your own
publications for the benefit of the field, almost anything relating to
molecular dynamics may be accepted. Please see the Open Source chapter for
more details.
+Because relax is free software, if you would like to contribute addition
features, functions, or modules which you have written for your own
publications for the benefit of the field, almost anything relating to
molecular dynamics may be accepted. Please see the Open Source chapter on
page~\pageref{ch: open source} for more details.
r17376 - in /trunk/docs/latex: develop.tex infrastruct.tex intro.tex