Author: bugman
Date: Tue Mar 28 05:25:27 2006
New Revision: 2421
URL: http://svn.gna.org/viewcvs/relax?rev=2421&view=rev
Log:
Spell check of the two manual chapters.
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=2421&r1=2420&r2=2421&view=diff
==============================================================================
--- 1.2/docs/latex/develop.tex (original)
+++ 1.2/docs/latex/develop.tex Tue Mar 28 05:25:27 2006
@@ -75,7 +75,7 @@
% Variable, function, and class names.
\subsection{Variable, function, and class names}
-In relax, a mixture of both camel case (eg. CamelCase) and lower case with
underscores is used. Despite the variablilty, there are fixed rules which
should be adhered to. These naming conventions should be observed at all
times.
+In relax, a mixture of both camel case (eg. CamelCase) and lower case with
underscores is used. Despite the variability, there are fixed rules which
should be adhered to. These naming conventions should be observed at all
times.
% Variables and functions.
@@ -104,7 +104,7 @@
The length of all lines in the commit log should never exceed 100
characters. This is so that the log message viewed in either emails or by
the command prompt command \texttt{svn log} is legible. The first line of
the commit log should be a short description or synopsis of the changes. The
second line should be blank.
-If the commit is a bug fix reported by someone else or if the commit
originates from a patch posted by someone else, the next lines should be
reserved for crediting. The name of the person and their obfusicated email
address (for example edward at nmr-relax.com) should be included in the
message.
+If the commit is a bug fix reported by someone else or if the commit
originates from a patch posted by someone else, the next lines should be
reserved for crediting. The name of the person and their obfuscated email
address (for example edward at nmr-relax.com) should be included in the
message.
If the commit relates to an entry in the bug tracker or to a discussion on
the mailing lists, then the web address of either the bug report or the
mailing list archive message should be cited in the next section (separated
from the synopsis or credit section by a blank line). All relevant links
should be included to allow easy navigation between the repository, mailing
lists, bug tracker, etc.
@@ -140,9 +140,9 @@
After proving oneself, anyone can become a relax developer and obtain commit
access to the relax repository. The main criteria for selection by the relax
developers is to show good judgement, competence in producing good patches,
compliance with the coding and commit log conventions, comportment on the
mailing lists, not producing too many bugs, only taking on challenges which
can be handled, and the skill in judging your own abilities. After a number
of patches have been submitted and accepted, any of the relax developers can
propose that you receive commit access. If a number of developers agree
while no one says no, then commit access will be offered.
-One area where coding ability can be demonstrated is within the relax test
suite. The addition of tests, especially those where the relax internal data
structures of \texttt{self.relax.data} are scrutinised, can be a good
starting point for learning the structure of relax. The beauty of the tests
are that the introduction of bugs has no effect on normal program executiong.
The relax test suite is an ideal proving ground.
-
-If skills in only certain areas of relax development, for example in
creation of the documentation, an understanding of C but not python, an
understanding of solely the code of the user interface, or an understanding
of the code specific to a certain type of data analysis methodology, then
partial commit access may be granted. Although you will have the ablity to
make modifications to any part of the repository, please make modifications
only those areas for which you have permission.
+One area where coding ability can be demonstrated is within the relax test
suite. The addition of tests, especially those where the relax internal data
structures of \texttt{self.relax.data} are scrutinised, can be a good
starting point for learning the structure of relax. The beauty of the tests
are that the introduction of bugs has no effect on normal program execution.
The relax test suite is an ideal proving ground.
+
+If skills in only certain areas of relax development, for example in
creation of the documentation, an understanding of C but not python, an
understanding of solely the code of the user interface, or an understanding
of the code specific to a certain type of data analysis methodology, then
partial commit access may be granted. Although you will have the ability to
make modifications to any part of the repository, please make modifications
only those areas for which you have permission.
@@ -216,4 +216,4 @@
\example{\$ scons clean}
-is run in the base directory, all Python byte compiled files `*.pyc', all C
object files `*.o' and `*.os', all C shared object files `*.so', and any
backup files with the extension `*.bak' are removed from all subdirectoies.
In addition, any temporary \LaTeX\ compilation files are removed from the
\texttt{`docs/latex'} directory.
+is run in the base directory, all Python byte compiled files `*.pyc', all C
object files `*.o' and `*.os', all C shared object files `*.so', and any
backup files with the extension `*.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=2421&r1=2420&r2=2421&view=diff
==============================================================================
--- 1.2/docs/latex/infrastruct.tex (original)
+++ 1.2/docs/latex/infrastruct.tex Tue Mar 28 05:25:27 2006
@@ -10,9 +10,9 @@
\section{The relax web sites}
-The main web site for relax is
\href{http://nmr-relax.com}{http://nmr-relax.com}. From these pages, general
information about the program, links to the latest documentation, links to
the most current software releases, and information about the mailing lists
are availible. There are also Google search capabilities built into the
pages for searching both the HTML version of the manual and the archives of
the mailing lists.
+The main web site for relax is
\href{http://nmr-relax.com}{http://nmr-relax.com}. From these pages, general
information about the program, links to the latest documentation, links to
the most current software releases, and information about the mailing lists
are available. There are also Google search capabilities built into the
pages for searching both the HTML version of the manual and the archives of
the mailing lists.
-The relax web site is hosted by the Gna! project
(\href{https://gna.org/}{https://gna.org/}) which is described as ``a central
point for development, distribution and maintenance of Libre Software (Free
Software) projects''. relax is a registered Gna! project and its primary
Gna! web site is
\href{https://gna.org/projects/relax}{https://gna.org/projects/relax}. This
site contains many more technical detailes than the main web site.
+The relax web site is hosted by the Gna! project
(\href{https://gna.org/}{https://gna.org/}) which is described as ``a central
point for development, distribution and maintenance of Libre Software (Free
Software) projects''. relax is a registered Gna! project and its primary
Gna! web site is
\href{https://gna.org/projects/relax}{https://gna.org/projects/relax}. This
site contains many more technical details than the main web site.
@@ -44,7 +44,7 @@
One of the philosophies in the construction of relax is that if there is
something which is not immediately obvious, then that is considered a design
bug. If any flaws in relax are uncovered, including general design flaws,
bugs in the code, or documentation issues, these can be reported within
relax's bug tracker system. The link to submit a bug is
\href{https://gna.org/bugs/?group=relax\&func=additem}{https://gna.org/bugs/?group=relax\&func=additem}
while the main page for browsing, submitting, viewing the statistics, or
searching through the data base is at
\href{https://gna.org/bugs/?group=relax}{https://gna.org/bugs/?group=relax}.
Please do not report bugs to personal email addresses or to the mailing lists.
-When reporting a bug, please include as much information as posible 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. Make sure that you are confident that the problem is trully a bug
prior to reporting it, if you have any doubts please feel free to ask on the
relax-users mailing list. To avoid duplicates, be sure that the bug has not
already been submitted to the bug tracker. You can search the bugs from the
page
\href{https://gna.org/project/search.php?group=relax}{https://gna.org/project/search.php?group=relax}.
+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. Make sure that you are confident that the problem is truly a bug
prior to reporting it, if you have any doubts please feel free to ask on the
relax-users mailing list. To avoid duplicates, be sure that the bug has not
already been submitted to the bug tracker. You can search the bugs 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 in the
`unified' format), and the guidelines for the format of the code.
@@ -55,7 +55,7 @@
\section{Latest sources -- the relax repositories}
-relax's source code is kept within a version control system called
Subversion
(\href{http://subversion.tigris.org/}{http://subversion.tigris.org/}).
Subversion, or SVN, 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 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 online 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.2, can be downloaded using the SVN protocol by typing
+relax's source code is kept within a version control system called
Subversion
(\href{http://subversion.tigris.org/}{http://subversion.tigris.org/}).
Subversion, or SVN, 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 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.2, can be downloaded using the SVN protocol by typing
\example{\$ svn co svn://svn.gna.org/svn/relax/1.2 relax}
@@ -63,7 +63,7 @@
\example{\$ svn co http://svn.gna.org/svn/relax/1.2 relax}
-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}.
+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}.
@@ -85,7 +85,7 @@
\example{\$ svn co svn://svn.gna.org/svn/relax/tags/1.2.3 relax}
-Again, the sources are availible through HTTP by typing
+Again, the sources are available through HTTP by typing
\example{\$ svn co http://svn.gna.org/svn/relax/tags/1.2.3 relax}
@@ -96,4 +96,4 @@
\$ scons binary\_dist
\end{exampleenv}
-At the end, Sconstruct will attempt to make a GPG signature for the newly
created archive, however, this will fail as the current relax private GPG key
is not availible for security reasons. If the Sconstruct command fails,
excluding the GPG signing, please submit a bug report 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
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
throughly 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 and
uploaded to
\href{http://download.gna.org/relax/}{http://download.gna.org/relax/}.
+At the end, Sconstruct will attempt to make a GPG signature for the newly
created archive, however, this will fail as the current relax private GPG key
is not available for security reasons. If the Sconstruct command fails,
excluding the GPG signing, please submit a bug report 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
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 and
uploaded to
\href{http://download.gna.org/relax/}{http://download.gna.org/relax/}.
r2421 - in /1.2/docs/latex: develop.tex infrastruct.tex