Author: bugman
Date: Tue Mar 28 04:01:06 2006
New Revision: 2416
URL: http://svn.gna.org/viewcvs/relax?rev=2416&view=rev
Log:
Major changes to the 'web' manual chapter including a name change to 'Open
source infrastructure'.
All sections have been heavily edited.
The 'Downloads' section has been renamed to 'The relax distribution archives'
and has been
significantly extended.
Modified:
1.2/docs/latex/web.tex
Modified: 1.2/docs/latex/web.tex
URL:
http://svn.gna.org/viewcvs/relax/1.2/docs/latex/web.tex?rev=2416&r1=2415&r2=2416&view=diff
==============================================================================
--- 1.2/docs/latex/web.tex (original)
+++ 1.2/docs/latex/web.tex Tue Mar 28 04:01:06 2006
@@ -1,7 +1,7 @@
% The web pages chapter.
%%%%%%%%%%%%%%%%%%%%%%%%
-\chapter{The web}
+\chapter{Open source infrastructure}
@@ -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 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 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 relax website is hosted by 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! webpage, which contains many more technical detailed than the main web
site, is
\href{https://gna.org/projects/relax}{https://gna.org/projects/relax}.
+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.
@@ -24,13 +24,13 @@
A number of mailing lists have been created covering different aspects of
relax. These include the announcement list, the relax users list, the relax
development list, and the relax committers list.
-The relax announcement list, "relax-announce at gna.org" is reserved for
important announcements about the program. All new program versions will be
announced on this list. The amount of traffic on this list is relatively
low, so if you would like to receive information about relax you can
subscribe to the list by vising the information page at
\href{https://mail.gna.org/listinfo/relax-announce/}{https://mail.gna.org/listinfo/relax-announce/}.
Previous announcements can be viewed at
\href{https://mail.gna.org/public/relax-announce/}{https://mail.gna.org/public/relax-announce/}.
+The relax announcement list, ``relax-announce at gna.org'' is reserved for
important announcements about the program including the release of new
program versions. The amount of traffic on this list is relatively low. If
you would like to receive information about relax you can subscribe to the
list by vising the information page at
\href{https://mail.gna.org/listinfo/relax-announce/}{https://mail.gna.org/listinfo/relax-announce/}.
Previous announcements can be viewed at
\href{https://mail.gna.org/public/relax-announce/}{https://mail.gna.org/public/relax-announce/}.
-If you would like to ask questions about relax, discuss certain features,
receive help, or to communicate on any other subject related to relax, the
mailing list "relax-users at gna.org" is the place to post your message. To
subscribe to the list, go to the relax-users information page at
\href{https://mail.gna.org/listinfo/relax-users/}{https://mail.gna.org/listinfo/relax-users/}.
You can also browse the mailing list archives at
\href{https://mail.gna.org/public/relax-users/}{https://mail.gna.org/public/relax-users/}.
+If you would like to ask questions about relax, discuss certain features,
receive help, or to communicate on any other subject related to relax, the
mailing list ``relax-users at gna.org'' is the place to post your message.
To subscribe to the list, go to the relax-users information page at
\href{https://mail.gna.org/listinfo/relax-users/}{https://mail.gna.org/listinfo/relax-users/}.
You can also browse the mailing list archives at
\href{https://mail.gna.org/public/relax-users/}{https://mail.gna.org/public/relax-users/}.
-A second mailing list exists for posts relating to the development of relax.
The list is "relax-devel at gna.org" and to subscribe, go to the relax-devel
information page at
\href{https://mail.gna.org/listinfo/relax-devel/}{https://mail.gna.org/listinfo/relax-devel/}.
Feature requests, program design, or any other posts relating to relax's
structure or code should be sent to this list instead. The mailing list
archives can be browsed at
\href{https://mail.gna.org/public/relax-devel/}{https://mail.gna.org/public/relax-devel/}.
+A second mailing list exists for posts relating to the development of relax.
The list is ``relax-devel at gna.org'' and to subscribe, go to the
relax-devel information page at
\href{https://mail.gna.org/listinfo/relax-devel/}{https://mail.gna.org/listinfo/relax-devel/}.
Feature requests, program design, or any other posts relating to relax's
structure or code should be sent to this list instead. The mailing list
archives can be browsed at
\href{https://mail.gna.org/public/relax-devel/}{https://mail.gna.org/public/relax-devel/}.
-When replying to a message on these lists, remember to hit 'respond to all'
so that the mailing list is included in the CC field. Otherwise your message
will only be sent to the original poster and not back to the list.
+When replying to a message on these lists, remember to hit `respond to all'
so that the mailing list is included in the CC field. Otherwise your message
will only be sent to the original poster and not return back to the list.
One last mailing list is the relax commits list. This list is reserved for
automatically generated posts created by the version control software which
looks after the relax source code and these web pages. If you would like to
become a developer, you can subscribe to the list at relax-commits
information page
\href{https://mail.gna.org/listinfo/relax-commits/}{https://mail.gna.org/listinfo/relax-commits/}.
The list can also be browsed at
\href{https://mail.gna.org/public/relax-commits/}{https://mail.gna.org/public/relax-commits/}.
@@ -44,9 +44,9 @@
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
it 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 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}.
-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 checkout 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.
+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,9 +55,7 @@
\section{Latest sources -- the relax repositories}
-The source code to relax is kept in 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 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
\example{\$ svn co svn://svn.gna.org/svn/relax/1.2 relax}
@@ -74,13 +72,28 @@
\section{News}
-Summaries of the latest news on relax can be found on the relax web site
\href{https://gna.org/projects/relax}{https://gna.org/projects/relax}.
However, more information can be found at the dedicated new page
\href{https://gna.org/news/?group=relax}{https://gna.org/news/?group=relax}.
+Summaries of the latest news on relax can be found on the relax web site
\href{https://gna.org/projects/relax}{https://gna.org/projects/relax}.
However, more information can be found at the dedicated news page
\href{https://gna.org/news/?group=relax}{https://gna.org/news/?group=relax}.
-% Downloads.
-%~~~~~~~~~~~
+% The relax distribution archives.
+%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-\section{Downloads}
+\section{The relax distribution archives}
-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/}.
+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. 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.2.3,
for example, type
+
+\example{\$ svn co svn://svn.gna.org/svn/relax/tags/1.2.3 relax}
+
+Again, the sources are availible through HTTP by typing
+
+\example{\$ svn co http://svn.gna.org/svn/relax/tags/1.2.3 relax}
+
+The binary distribution can then be created for your architecture by
shifting to the main directory of the checked out sources and typing
+
+\begin{exampleenv}
+\$ cd relax \\
+\$ 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/}.
r2416 - /1.2/docs/latex/web.tex