Author: bugman
Date: Mon Oct 8 11:04:32 2012
New Revision: 17737
URL: http://svn.gna.org/viewcvs/relax?rev=17737&view=rev
Log:
Updated the relax version numbers and 'trunk' used relax user manual.
For example the information about checking out the main development line was
still talking about 1.3
rather than the trunk.
Modified:
trunk/docs/latex/develop.tex
trunk/docs/latex/infrastruct.tex
Modified: trunk/docs/latex/develop.tex
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/develop.tex?rev=17737&r1=17736&r2=17737&view=diff
==============================================================================
--- trunk/docs/latex/develop.tex (original)
+++ trunk/docs/latex/develop.tex Mon Oct 8 11:04:32 2012
@@ -16,13 +16,13 @@
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/}.
-If you are not currently a relax developer you can check out the head
revision, assuming that 1.2 is the current major version number, by typing
-
-\example{\$ svn co svn://svn.gna.org/svn/relax/1.2 relax}
+If you are not currently a relax developer you can check out the head
revision by typing
+
+\example{\$ svn co svn://svn.gna.org/svn/relax/trunk relax-trunk}
Otherwise if you are a developer type
-\example{\$ svn co svn+ssh://xxxxx@xxxxxxxxxxx/svn/relax/1.2 relax}
+\example{\$ svn co svn+ssh://xxxxx@xxxxxxxxxxx/svn/relax/trunk relax-trunk}
replacing \prompt{xxxxx} with your Gna!\ login name. If your version is out
of date it can be updated to the latest revision by typing
@@ -277,7 +277,7 @@
\subsection{Modification of official releases -- creating patches with diff}
\index{patch!diff|textbf}
-If your modifications have been made to the source code of one of the
official relax releases (for example 1.2.2) then the Unix command \file{diff}
can be used to create a patch. A patch file is simply the output of the diff
command run with the recursive flag and presented in the `unified' format.
Therefore two directories need to be compared. If the original sources are
located in the directory \directory{relax\_orig} and the modified sources in
\directory{relax\_mod} then the patch can be created by typing
+If your modifications have been made to the source code of one of the
official relax releases (for example 2.1.1) then the Unix command \file{diff}
can be used to create a patch. A patch file is simply the output of the diff
command run with the recursive flag and presented in the `unified' format.
Therefore two directories need to be compared. If the original sources are
located in the directory \directory{relax\_orig} and the modified sources in
\directory{relax\_mod} then the patch can be created by typing
\example{\$ diff -ur relax\_orig relax\_mod > patch}
@@ -413,10 +413,10 @@
\subsection{Branch creation}
\index{repository!branch creation}
-If a change is likely to be disruptive or cause breakages in the program,
the use of your own temporary branch is recommended. This private branch is
a complete copy of one of the main development lines wherein you can make
changes without disrupting the other developers. Although called a private
branch every change is visible to all other developers and each commit will
result in an automatic email to the relax-commits mailing list\index{mailing
list!relax-commits}. Other developers are even able to check out your branch
and make modifications to it. Private branches can also be used for testing
ideas. If the idea does not work the branch can be deleted from the
repository (in reality the branch will always exist between the revision
numbers of its creation and deletion and can always be resurrected). For
example to create a branch from the main 1.3 development line called
\prompt{molmol\_macros} whereby new Molmol macros are to be written, type
+If a change is likely to be disruptive or cause breakages in the program,
the use of your own temporary branch is recommended. This private branch is
a complete copy of one of the main development lines wherein you can make
changes without disrupting the other developers. Although called a private
branch every change is visible to all other developers and each commit will
result in an automatic email to the relax-commits mailing list\index{mailing
list!relax-commits}. Other developers are even able to check out your branch
and make modifications to it. Private branches can also be used for testing
ideas. If the idea does not work the branch can be deleted from the
repository (in reality the branch will always exist between the revision
numbers of its creation and deletion and can always be resurrected). For
example to create a branch from the main development line, the `trunk',
called \prompt{molmol\_macros} whereby new Molmol macros are to be written,
type
\begin{exampleenv}
-\$ svn cp svn+ssh://xxxxx@xxxxxxxxxxx/svn/relax/1.3 $\backslash$ \\
+\$ svn cp svn+ssh://xxxxx@xxxxxxxxxxx/svn/relax/trunk $\backslash$ \\
svn+ssh://xxxxx@xxxxxxxxxxx/svn/relax/branches/molmol\_macros
\end{exampleenv}
@@ -459,7 +459,7 @@
Once you have completed the modifications desired for your branch, all
changes which have occurred in the main line have been merged using
\file{svnmerge.py}, and the changes have been approved for merging back into
the main line -- then your branch can be merged. First check out a copy of
the main line,
-\example{\$ svn co svn+ssh://xxxxx@xxxxxxxxxxx/svn/relax/1.3 relax-1.3}
+\example{\$ svn co svn+ssh://xxxxx@xxxxxxxxxxx/svn/relax/trunk relax-trunk}
\index{Subversion!check out}
or update a previously checked out version,
Modified: trunk/docs/latex/infrastruct.tex
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/infrastruct.tex?rev=17737&r1=17736&r2=17737&view=diff
==============================================================================
--- trunk/docs/latex/infrastruct.tex (original)
+++ trunk/docs/latex/infrastruct.tex Mon Oct 8 11:04:32 2012
@@ -77,14 +77,14 @@
\section{Latest sources -- the relax repositories}
\index{repository|textbf}
-relax's source code is kept within a version control system called
Subversion\index{Subversion|textbf}
(\href{http://subversion.tigris.org/}{http://subversion.tigris.org/}).
Subversion or SVN\index{SVN|textbf} allows fine control over the development
of the program. The repository contains all information about every change
ever made to the program. To learn more about the system the Subversion
book\index{Subversion!book} located at
\href{http://svnbook.red-bean.com/}{http://svnbook.red-bean.com/} is a good
place to start. The contents of the relax repository can be viewed on-line
at
\href{http://svn.gna.org/viewcvs/relax/}{http://svn.gna.org/viewcvs/relax/}.
The current sources, assuming that the most recent minor version number is
1.3, can be downloaded using the SVN protocol by typing
+relax's source code is kept within a version control system called
Subversion\index{Subversion|textbf}
(\href{http://subversion.tigris.org/}{http://subversion.tigris.org/}).
Subversion or SVN\index{SVN|textbf} allows fine control over the development
of the program. The repository contains all information about every change
ever made to the program. To learn more about the system the Subversion
book\index{Subversion!book} located at
\href{http://svnbook.red-bean.com/}{http://svnbook.red-bean.com/} is a good
place to start. The contents of the relax repository can be viewed on-line
at
\href{http://svn.gna.org/viewcvs/relax/}{http://svn.gna.org/viewcvs/relax/}.
The current sources can be downloaded using the SVN protocol by typing
-\example{\$ svn co svn://svn.gna.org/svn/relax/1.3 relax}
+\example{\$ svn co svn://svn.gna.org/svn/relax/trunk relax-trunk}
\index{Subversion!check out}
however if this does not work, try the command
-\example{\$ svn co http://svn.gna.org/svn/relax/1.3 relax}
+\example{\$ svn co http://svn.gna.org/svn/relax/trunk relax-trunk}
\index{Subversion!check out}
to download using the HTTP protocol. The entire relax repository is backed
up daily to
\href{http://svn.gna.org/daily/relax.dump.gz}{http://svn.gna.org/daily/relax.dump.gz}\index{repository!back
up}.
@@ -107,14 +107,14 @@
\section{The relax distribution archives}
\index{distribution archive}
-The relax distribution archives, the files to download to install relax, can
be found at
\href{http://download.gna.org/relax/}{http://download.gna.org/relax/}. If a
compiled binary distribution for your architecture does not exist you are
welcome to create this distribution yourself and submit it for inclusion in
the relax project. To do this a number of steps are required. Firstly, the
code to each relax release or version resides in the `tags' directory of the
relax repository. To check out version 1.3.15 for example type
+The relax distribution archives, the files to download to install relax, can
be found at
\href{http://download.gna.org/relax/}{http://download.gna.org/relax/}. If a
compiled binary distribution for your architecture does not exist you are
welcome to create this distribution yourself and submit it for inclusion in
the relax project. To do this a number of steps are required. Firstly, the
code to each relax release or version resides in the `tags' directory of the
relax repository. To check out version 2.1.1 for example type
-\example{\$ svn co svn://svn.gna.org/svn/relax/tags/1.3.15 relax}
+\example{\$ svn co svn://svn.gna.org/svn/relax/tags/2.1.1 relax}
\index{Subversion!check out}
Again the sources are available through HTTP by typing
-\example{\$ svn co http://svn.gna.org/svn/relax/tags/1.3.15 relax}
+\example{\$ svn co http://svn.gna.org/svn/relax/tags/2.1.1 relax}
\index{Subversion!check out}
The binary distribution can then be created for your architecture by
shifting to the main directory of the checked out sources and typing
r17737 - in /trunk/docs/latex: develop.tex infrastruct.tex