1 <b>Anonymous CVS access</b>
4 Anonymous CVS access is now available to SILC CVS repository. The
5 repository includes everything related to SILC project; source codes,
6 documentation and even these web pages. The CVS access is of course public
7 but it is intended for developers. After you have checked out the SILC
8 source tree you should read README.CVS file from the source tree or rest
11 Also note that this is the closest to real time development you can get
12 thus you cannot expect that the source tree would work or even compile.
13 While it is our intention that the trunk would always at least compile
14 there might be situations when it will not.
18 <b>Browsing the Source Tree</b>
20 If you want to browse the source tree using web browser before checking
21 out the tree with CVS use following link:
23 <a href="http://cvs.silcnet.org/">Web Access to CVS repository
26 Note that this is not real-time access to the CVS repository. It is
27 updated once a day. If you want real-time access then checkout the CVS
32 <b>Howto Checkout The Source Tree</b>
34 The repository can be checked out by using anonymous pserver with CVS.
36 For those who are using sh/ksh/bashi/zsh the check out is done as follows:
40 export CVSROOT=:pserver:cvs@cvs.silcnet.org:/cvs/silc
49 For those who are using csh/tcsh the check out is done as follows:
53 setenv CVSROOT :pserver:cvs@cvs.silcnet.org:/cvs/silc
61 If you don't want to set $CVSROOT environment variable you can set the
62 path to the cvs as command line option:
66 cvs -d:pserver:cvs@cvs.silcnet.org:/cvs/silc login<br />
67 cvs -d:pserver:cvs@cvs.silcnet.org:/cvs/silc co silc<br />
68 cvs -d:pserver:cvs@cvs.silcnet.org:/cvs/silc logout
72 Whatever method you will decide to use, after you have done cvs login you will
73 be prompted for password:
75 <b>CVS password: </b>silc
77 Type the password "silc" and press <ENTER>
79 The actual SILC source tree is checked out using the cvs co silc command,
80 described above. This command will fetch the source tree and save it into
81 directory named silc. SILC CVS repository currently does not have any
82 branches thus this will check out the trunk. The size of the trunk is
83 currently about 13 MB but will grow in the future.
87 <b>What SILC Source Tree Includes</b>
89 SILC Source tree includes a lot more stuff that appears in public
90 distribution. The source tree includes, for example, internal scripts,
91 configuration files, SILC webpages etc. These never appear on a public
94 Following directories currently exist in SILC source tree.
100 Includes all the SILC documentation. Few parts of the documentation
101 are generated when distribution is generated. The automatically
102 generated files should never be commited to CVS.
106 Includes SILC include files.
110 Includes SILC libraries. There are maybe libraries in the CVS which
111 are not inclduded in public distribution.
115 Includes the official SILC web pages and everything related to them.
116 This directory will never appear in public distribution.
120 Includes SILC client. There can be some extra files that will
121 never appear in public distribution, such as configuration files.
125 Includes SILC server. There can be some extra files that will
126 never appear in public distribution, such as configuration files.
132 <b>Howto Compile SILC Source Tree</b>
134 After checkout from CVS the SILC source tree needs to be prepared for
135 configuration and compilation. To compile the source tree, type:
140 ./configure --enable-debug<br />
142 note: on non-Linux operating systems GNU make (gmake) is prefered
147 The ./prepare script is included in the source tree and it will never
148 appears in public distribution. The script prepares the source tree
149 by creating configuration scripts and Makefiles. The prepare must be
150 run every time you made any changes to configuration scripts (however,
151 making changes to Makefile.am's does not require running ./prepare).
153 As a developer you should read the ./configure script's help by typing
154 ./configure --help and study all of its different options. Also you
155 should configure the script with --enable-debug option as it compiles
156 SILC with -g (debugging) option and it enables the SILC_LOG_DEBUG*
157 scripts. Warning is due here: The debugging produced by both cilent
158 and server is very huge, thus it is common to test the programs as
163 ./silc -d -f configfile 2>log<br />
164 ./silcd -d -f configfile 2>log
170 <b>How to clean SILC Source Tree</b>
172 To entirely clear the source tree to the state after it was checked out
181 This calls `make distclean' plus removes automatically generated files
182 by hand. It also removes *.log files. However, it will not remove any
183 other files you might have created.
187 <b>Makefiles and configuration files</b>
189 Developers should never directly write a Makefile. All Makefiles are
190 always automatically generated by ./prepare and later by ./configure
191 scripts. Instead, developers have to write Makefile.am files. There
192 are plenty of examples what they should look like. If you changed
193 Makefile.am during development you do not need to run ./prepare, just
196 Configuration files are the files that ./prepare automatically generates
197 and which will be included into public distribution. ./prepare creates
198 for example the ./configure script that is not commited to the CVS.
199 `configure.in' is the file that developers have to edit to change ./configure
200 script. After doing changes you need to run ./prepare.