Added SILC Thread Queue API

[silc.git] / public_html / html / cvs.php

&nbsp;<br />
<b><big>Anonymous CVS access</big></b>
<br />&nbsp;<br />
Anonymous CVS access is now available to SILC CVS repository. The
repository includes everything related to SILC project; source codes,
documentation and even these web pages. The CVS access is of course public
but it is intended for developers. After you have checked out the SILC
source tree you should read README.CVS file from the source tree or rest
of this web page.
<br />&nbsp;<br />
Also note that this is the closest to real time development you can get
thus you cannot expect that the source tree would work or even compile.
While it is our intention that the trunk would always at least compile
there might be situations when it will not.

<br />&nbsp;<br />

<b>Browsing the Source Tree</b>
<br />&nbsp;<br />
If you want to browse the source tree using web browser before checking
out the tree with CVS use following link:
<br />&nbsp;<br />
<a href="http://cvs.silcnet.org/" class="normal">Web Access to CVS repository
</a>
<br />&nbsp;<br />
Note that this is not real-time access to the CVS repository. It is
updated once a day. If you want real-time access then checkout the CVS
repository.

<br />&nbsp;<br />

<b>Howto Checkout The Source Tree</b>
<br />&nbsp;<br />
The repository can be checked out by using anonymous pserver with CVS.
<br />&nbsp;<br />
For those who are using sh/ksh/bash/zsh the check out is done as follows:
<br />&nbsp;<br />
<tt class="highlight">
export CVSROOT=:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?>
<br />&nbsp;<br />
cvs login<br />
cvs co silc<br />
cvs logout<br />
</tt>

<br />&nbsp;<br />
For those who are using csh/tcsh the check out is done as follows:
<br />&nbsp;<br />
<tt class="highlight">
setenv CVSROOT :pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?>
<br />&nbsp;<br />
cvs login<br />
cvs co silc<br />
cvs logout<br />
</tt>
<br />&nbsp;<br />
If you don't want to set $CVSROOT environment variable you can set the
path to the cvs as command line option:
<br />&nbsp;<br />
<tt class="highlight">
cvs -d:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?> login
<br />
cvs -d:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?> co silc
<br />
cvs -d:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?> logout
</tt>
<br />&nbsp;<br />
Whatever method you will decide to use, after you have done cvs login you will
be prompted for password:
<br />&nbsp;<br />
<b>CVS password: </b>silc
<br />&nbsp;<br />
Type the password "silc" and press &lt;ENTER&gt;
<br />&nbsp;<br />
The actual SILC source tree is checked out using the cvs co silc command,
described above. This command will fetch the source tree and save it into
directory named silc. SILC CVS repository currently does not have any
branches thus this will check out the trunk. The size of the trunk is
currently about 13 MB but will grow in the future.

<br />&nbsp;<br />

<b>What SILC Source Tree Includes</b>
<br />&nbsp;<br />
SILC Source tree includes a lot more stuff that appears in public
distribution. The source tree includes, for example, internal scripts,
configuration files, SILC webpages etc. These never appear on a public
distribution.
<br />&nbsp;<br />
Following directories currently exist in SILC source tree.
<br />&nbsp;<br />
<tt class="highlight">
doc/
<br />&nbsp;<br />
&nbsp; Includes all the SILC documentation. Few parts of the documentation<br />
&nbsp; are generated when distribution is generated. The automatically<br />
&nbsp; generated files should never be commited to CVS.<br />
<br />&nbsp;<br />
includes/
<br />&nbsp;<br />
&nbsp; Includes SILC include files.
<br />&nbsp;<br />
lib/
<br />&nbsp;<br />
&nbsp; Includes SILC libraries. There are maybe libraries in the CVS which<br />
&nbsp; are not inclduded in public distribution.<br />
<br />&nbsp;<br />
public_html/
<br />&nbsp;<br />
&nbsp; Includes the official SILC web pages and everything related to them.<br />
&nbsp; This directory will never appear in public distribution.<br />
<br />&nbsp;<br />
silc/
<br />&nbsp;<br />
&nbsp; Includes SILC client. There can be some extra files that will<br />
&nbsp; never appear in public distribution, such as configuration files.<br />
<br />&nbsp;<br />
silcd/
<br />&nbsp;<br />
&nbsp; Includes SILC server. There can be some extra files that will<br />
&nbsp; never appear in public distribution, such as configuration files.<br />
</tt>

<br />&nbsp;<br />

<b>Howto Compile SILC Source Tree</b>
<br />&nbsp;<br />
After checkout from CVS the SILC source tree needs to be prepared for
configuration and compilation. To compile the source tree, type:
<br />&nbsp;<br />
<tt class="highlight">
./prepare<br />
./configure --enable-debug<br />
make<br />&nbsp;<br />
note: on non-GNU/Linux operating systems GNU make (gmake) is prefered
</tt>
<br />&nbsp;<br />

The ./prepare script is included in the source tree and it will never
appears in public distribution. The script prepares the source tree
by creating configuration scripts and Makefiles. The prepare must be
run every time you made any changes to configuration scripts (however,
making changes to Makefile.am's does not require running ./prepare).
<br />&nbsp;<br />
As a developer you should read the ./configure script's help by typing
./configure --help and study all of its different options. Also you
should configure the script with --enable-debug option as it compiles
SILC with -g (debugging) option and it enables the SILC_LOG_DEBUG*
scripts. Warning is due here:  The debugging produced by both cilent
and server is very huge, thus it is common to test the programs as
follows:
<br />&nbsp;<br />
<tt class="highlight">
./silc -d "*" -f configfile 2&gt;log<br />
./silcd -d "*" -f configfile 2&gt;log
</tt>

<br />&nbsp;<br />
The -d option enables the debug printing.  The argument for the -d option
is a string that is used to match the output debug.  The example "*" will
match for everything, and all debugs will be printed.  If you want to
limit the debugs you want to printout you can give for example a string
like "*server*,*rng*" to match all functions, and filenames that has
"server" or "rng" string in them.  Others will not be printed out.  You 
can freely define regural expressions as debug string.

<br />&nbsp;<br />

<b>How to clean SILC Source Tree</b>
<br />&nbsp;<br />
To entirely clear the source tree to the state after it was checked out
from CVS, type:
<br />&nbsp;<br />
<tt class="highlight">
./prepare-clean
</tt>
<br />&nbsp;<br />

This calls `make distclean' plus removes automatically generated files
by hand. It also removes *.log files. However, it will not remove any
other files you might have created.

<br />&nbsp;<br />

<b>Makefiles and configuration files</b>
<br />&nbsp;<br />
Developers should never directly write a Makefile. All Makefiles are
always automatically generated by ./prepare and later by ./configure
scripts. Instead, developers have to write Makefile.am files. There
are plenty of examples what they should look like. If you changed
Makefile.am during development you do not need to run ./prepare, just
run normal make.
<br />&nbsp;<br />
Configuration files are the files that ./prepare automatically generates
and which will be included into public distribution. ./prepare creates
for example the ./configure script that is not commited to the CVS.
`configure.in' is the file that developers have to edit to change ./configure