2 <b><big>Anonymous CVS access</big></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/" class="normal">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/bash/zsh the check out is done as follows:
38 <tt class="highlight">
39 export CVSROOT=:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?>
47 For those who are using csh/tcsh the check out is done as follows:
49 <tt class="highlight">
50 setenv CVSROOT :pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?>
57 If you don't want to set $CVSROOT environment variable you can set the
58 path to the cvs as command line option:
60 <tt class="highlight">
61 cvs -d:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?> login
63 cvs -d:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?> co silc
65 cvs -d:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?> logout
68 Whatever method you will decide to use, after you have done cvs login you will
69 be prompted for password:
71 <b>CVS password: </b>silc
73 Type the password "silc" and press <ENTER>
75 The actual SILC source tree is checked out using the cvs co silc command,
76 described above. This command will fetch the source tree and save it into
77 directory named silc. SILC CVS repository currently does not have any
78 branches thus this will check out the trunk. The size of the trunk is
79 currently about 13 MB but will grow in the future.
83 <b>What SILC Source Tree Includes</b>
85 SILC Source tree includes a lot more stuff that appears in public
86 distribution. The source tree includes, for example, internal scripts,
87 configuration files, SILC webpages etc. These never appear on a public
90 Following directories currently exist in SILC source tree.
92 <tt class="highlight">
95 Includes all the SILC documentation. Few parts of the documentation<br />
96 are generated when distribution is generated. The automatically<br />
97 generated files should never be commited to CVS.<br />
101 Includes SILC include files.
105 Includes SILC libraries. There are maybe libraries in the CVS which<br />
106 are not inclduded in public distribution.<br />
110 Includes the official SILC web pages and everything related to them.<br />
111 This directory will never appear in public distribution.<br />
115 Includes SILC client. There can be some extra files that will<br />
116 never appear in public distribution, such as configuration files.<br />
120 Includes SILC server. There can be some extra files that will<br />
121 never appear in public distribution, such as configuration files.<br />
126 <b>Howto Compile SILC Source Tree</b>
128 After checkout from CVS the SILC source tree needs to be prepared for
129 configuration and compilation. To compile the source tree, type:
131 <tt class="highlight">
133 ./configure --enable-debug<br />
134 make<br /> <br />
135 note: on non-GNU/Linux operating systems GNU make (gmake) is prefered
139 The ./prepare script is included in the source tree and it will never
140 appears in public distribution. The script prepares the source tree
141 by creating configuration scripts and Makefiles. The prepare must be
142 run every time you made any changes to configuration scripts (however,
143 making changes to Makefile.am's does not require running ./prepare).
145 As a developer you should read the ./configure script's help by typing
146 ./configure --help and study all of its different options. Also you
147 should configure the script with --enable-debug option as it compiles
148 SILC with -g (debugging) option and it enables the SILC_LOG_DEBUG*
149 scripts. Warning is due here: The debugging produced by both cilent
150 and server is very huge, thus it is common to test the programs as
153 <tt class="highlight">
154 ./silc -d "*" -f configfile 2>log<br />
155 ./silcd -d "*" -f configfile 2>log
159 The -d option enables the debug printing. The argument for the -d option
160 is a string that is used to match the output debug. The example "*" will
161 match for everything, and all debugs will be printed. If you want to
162 limit the debugs you want to printout you can give for example a string
163 like "*server*,*rng*" to match all functions, and filenames that has
164 "server" or "rng" string in them. Others will not be printed out. You
165 can freely define regural expressions as debug string.
169 <b>How to clean SILC Source Tree</b>
171 To entirely clear the source tree to the state after it was checked out
174 <tt class="highlight">
179 This calls `make distclean' plus removes automatically generated files
180 by hand. It also removes *.log files. However, it will not remove any
181 other files you might have created.
185 <b>Makefiles and configuration files</b>
187 Developers should never directly write a Makefile. All Makefiles are
188 always automatically generated by ./prepare and later by ./configure
189 scripts. Instead, developers have to write Makefile.am files. There
190 are plenty of examples what they should look like. If you changed
191 Makefile.am during development you do not need to run ./prepare, just
194 Configuration files are the files that ./prepare automatically generates
195 and which will be included into public distribution. ./prepare creates
196 for example the ./configure script that is not commited to the CVS.
197 `configure.in' is the file that developers have to edit to change ./configure