[Aglets-commits] docs manual.tex,1.24,1.25

[Luca F. <cat...@us...>]

Update of /cvsroot/aglets/docs
In directory 23jxhf1.ch3.sourceforge.com:/tmp/cvs-serv12680

Modified Files:
	manual.tex 
Log Message:
Updated the cvs-installation section.


Index: manual.tex
===================================================================
RCS file: /cvsroot/aglets/docs/manual.tex,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -d -r1.24 -r1.25
--- manual.tex	1 Apr 2009 12:06:49 -0000	1.24
+++ manual.tex	17 Apr 2009 13:43:51 -0000	1.25
@@ -705,52 +705,63 @@
 
 
 \section{Installing from CVS}
-You can install the Aglets platform from the CVS repository. The following are the required steps:
+You can install the Aglets platform from the CVS repository. This make sense in the case of active development or if you
+want to keep up to date with on-going development. Please note that downloading the sources from the CVS repository
+requires that you manually compile the source tree in order to get a working release. Moreover, since the CVS hosts
+on-going development, sources in the CVS tree could have bugs and testing features, so if you are going to install Aglets
+on a production environment, please use a binary (stable) release.
+
+The following are the required steps to get a copy from the CVS:
 \begin{enumerate}
 \item \underline{Create the directory for the repository:}\newline
- You need to create a directory playing as a container for the CVS repository. In this directory you will download a copy
+You need to create a container directory  for the CVS repository. In this directory you will download a copy
 of all sources currently in the CVS repository.
 
-\item \underline{Log in to the CVS server:}\newline
-To log in to the CVS server do the following:
-\begin{center}
-\begin{verbatim}
-luca@linux:/java/aglets/bin> cvs 
-    -d:pserver:ano...@cv...:/cvsroot/aglets 
-    login
-\end{verbatim}
-\end{center}
-The server will respond with
+
+
+\item \underline{Download the source tree:}\newline
+You need to download from the \emph{aglets} module, thus do:
 \begin{center}
 \begin{verbatim}
-Logging in to 
-  :pserver:ano...@cv...:2401/cvsroot/aglets
-CVS password:
+cvs -d:pserver:ano...@ag...:/cvsroot/aglets checkout aglets
 \end{verbatim}
 \end{center}
-No password is required for anonymous access, so simply leave it blank. After the login, the command prompt of your shell will be shown again. Now you are logged in the CVS server, and you can download the source tree.
 
-\item \underline{Download the source tree:}\newline
-You need to download from the \emph{aglets} module, thus do:
+Please note that the above is an anonymous checkout. Anonymous checkout are used as read-only checkouts, that is you will have
+a copy of the source tree, but you will not be able to commit back changes to the main repository. You should use anonymous
+checkouts each time you'd like to get a copy to recompile and try but you are not actively involved in the development.
+If you are a registered SourceForge user and have been granted CVS access, you can checkout your own copy of the
+source tree doing:
+
 \begin{center}
 \begin{verbatim}
-luca@linux:/java/aglets/bin> cvs 
-   -d:pserver:ano...@cv...:/cvsroot/aglets 
-   checkout aglets
+cvs -d:ext:you...@ag...:/cvsroot/aglets checkout aglets
 \end{verbatim}
 \end{center}
 
-The system will download (or update if you have already a version of the CVS repository) each source file in the on-line repository, placing files into a subdirectory with the same name of the module (in this case \emph{aglets}). After that you can logout doing:
+The difference between the former and the anonymous checkout is that providing your username you will be able to send back
+changes to the sources (commits) and actively develop the project. 
+
+In order to be able to contribute to the project, and therefore to checkout the repository in a non-anonymous way, you must
+first register to the SourceForge web site, so that a new user will be created. Once you have a valid SourceForge username,
+you must get CVS access for the Aglets project. To request access to the repository please drop an e-mail to \texttt{cat...@us...},
+presenting yourself and motivating your interest in the development.
+
+
+\item \underline{Compile the downloaded source tree:}\newline
+The source tree you have downloaded must be compiled in order to build the Aglets library and platform. 
+Enter in the \emph{src} subdirectory and run Ant there:
+
 \begin{center}
 \begin{verbatim}
-luca@linux:/java/aglets/bin> cvs 
-    -d:pserver:ano...@cv...:/cvsroot/aglets 
-    logout
+cd aglets/src
+ant
 \end{verbatim}
 \end{center}
 
-\item \underline{Compile the downloaded source tree:}\newline
-The source tree you have downloaded must be compiled in order to build the Aglets library and platform. Enter in the \emph{src} subdirectory and run Ant there, you will see the compilation of all sources. At the end of the compilation, the library and the platform will be installed in the module directory (i.e., the parent directory of the \emph{src} one).
+ 
+The system will start compiling the sources and at the end of the process you will have the
+classes ready to be used. The library and the platform will be installed in the module directory (i.e., the parent directory of the \emph{src} one).