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/bash the check out is done as follows:
40 export CVSROOT=:pserver:cvs@cvs.silcnet.org:/cvs/silc
48 For those who are using csh/tcsh the check out is done as follows:
52 setenv CVSROOT :pserver:cvs@cvs.silcnet.org:/cvs/silc
59 If you don't want to set $CVSROOT environment variable you can set the
60 path to the cvs as command line options:
64 cvs -d:pserver:cvs@cvs.silcnet.org:/cvs/silc login<br>
65 cvs -d:pserver:cvs@cvs.silcnet.org:/cvs/silc co silc
69 What ever method you decide to use, after you have done cvs login you will
70 be prompted for password:
72 <b>CVS password: </b>silc
74 Type the password "silc" and press Enter.
76 The actual SILC source tree is checked out using the cvs co silc command,
77 described above. This command will fetch the source tree and save it into
78 directory named silc. SILC CVS repository currently does not have any
79 branches thus this will check out the trunk. The size of the trunk is
80 currently about 13 MB but will grow in the future.
84 <b>What SILC Source Tree Includes</b>
86 SILC Source tree includes a lot more stuff that appears in public
87 distribution. The source tree includes, for example, internal scripts,
88 configuration files, SILC webpages etc. These never appear on a public
91 Following directories currently exist in SILC source tree.
97 Includes all the SILC documentation. Some of the documentation
98 are generated when distribution is generated. The automatically
99 generated files must never be commited to CVS.
103 Includes SILC include files.
107 Includes SILC libraries. There maybe libraries on the CVS that
108 does not appear on public distribution.
112 Includes the official SILC web pages and everything that relates
113 to them. This directory never appears on public distribution.
117 Includes SILC client. There can be some extra files that will
118 never appear in public distribution, such as, configuration files.
122 Includes SILC server. There can be some extra files that will
123 never appear in public distribution, such as, configuration files.
129 <b>Howto Compile SILC Source Tree</b>
131 After checkout from CVS the SILC source tree must be prepared for
132 configuration and compilation. To compile the source tree, give,
137 ./configure --enable-debug<br>
143 The ./prepare script is included in to the source tree and it never
144 appears in public distribution. The script prepares the source tree
145 by creating configuration scripts and Makefiles. The prepare must be
146 run every time you make some changes to configuration scripts (however,
147 making changes to Makefile.am's does not require running ./prepare).
149 As a developer you should read the ./configure script's help by
150 giving ./configure --help and study all of its different options. Also,
151 you should configure the script with --enable-debug option as it
152 compiles SILC with -g (debugging) option and it enables the
153 SILC_LOG_DEBUG* scripts. Warning is due here: The debugging produced
154 by both cilent and server is very heavy, thus it is common to test
155 the programs as follows:
159 ./silc -d -f configfile 2>log<br>
160 ./silcd -d -f configfile 2>log
166 <b>Howto Clean SILC Source Tree</b>
168 To entirely clear the source tree to the state after it was checked out
177 This calls `make distclean' plus removes automatically generated files
178 by hand. It also removes *.log files. However, it will not remove
179 any other files you might have created.
183 <b>Makefiles and configuration files</b>
185 Developers should never directly write a Makefile. All Makefiles are
186 always automatically generated by ./prepare and later by ./configure
187 scripts. Instead, developers must write Makefile.am files. There
188 are plenty of examples what they should look like. If you change
189 Makefile.am during development you don't have to run ./prepare, just
192 Configuration files are the files that ./prepare automatically generates
193 and what will be included into public distribution. ./prepare creates
194 for example the ./configure script that is not commited to the CVS.
195 `configure.in' is the file that developers must edit to change ./configure
196 script. After changing one must run ./prepare.
projects / runtime.git / blob