public_html/cvs.html

   1 <html>
   2 <style TYPE="text/css"><!-- A:link {text-decoration: none}A:visited{text-decoration:none}A:active{text-decoration:none}--></style>
   3 <body bgcolor="#ffffff">
   4 <p><br>
   5 <a href="index.html"><img src="silc2.jpg" border=0></a>
   6 <table width="70%" border="0" cellspacing="0" cellpadding="1"
   7 align=center>
   8 <tr>
   9 <td>
  10 <font face="Arial,Helvetica,Sans-serif">
  11 <p>
  12 <font size=4>
  13 <h1>Anonymous CVS Access</h1>
  14 <p>
  15 Anonymous CVS access is now available to SILC CVS repository. The
  16 repository includes everything related to SILC project; source codes,
  17 documentation and even these web pages. The CVS access is of course public
  18 but it is intended for developers.  After you have checked out the SILC
  19 source tree you should read README.CVS file from the source tree or rest
  20 of this web page.
  21
  22 <p>
  23 Also note that this is the closest to real time development you can get
  24 thus you cannot expect that the source tree would work or even compile.
  25 While it is our intention that the trunk would always at least compile
  26 there might be situations when it will not.
  27
  28 <p><br>
  29 <h1>Browsing the Source Tree</h1>
  30 <p>
  31 If you want to browse the source tree using web browser before checking
  32 out the tree with CVS use following link:
  33 <p>
  34 <a href="http://silcnet.org/cvs/source/">Web Access to CVS repository
  35 </a>
  36 <p>
  37 Note that this is not real-time access to the CVS repository. It is
  38 updated once a day. If you want real-time access then checkout the CVS
  39 repository.
  40
  41 <p><br>
  42 <h1>Howto Checkout The Source Tree</h1>
  43 <p>
  44 The repository can be checked out by using anonymous pserver with CVS.
  45 <p>
  46 For those who are using sh/ksh/bash the check out is done as follows:
  47 <p>
  48 <dd><b>
  49 export CVSROOT=:pserver:silc@silc.pspt.fi:/storage/silc/CVS
  50 </b>
  51 <dd><b>cvs login</b>
  52 <dd><b>cvs co silc</b>
  53
  54 <p>
  55 For those who are using csh/tcsh the check out is done as follows:
  56 <p>
  57 <dd><b>
  58 setenv CVSROOT :pserver:silc@silc.pspt.fi:/storage/silc/CVS
  59 </b>
  60 <dd><b>cvs login</b>
  61 <dd><b>cvs co silc</b>
  62
  63 <p>
  64 If you don't want to set $CVSROOT environment variable you can set the
  65 path to the cvs as command line options:
  66 <p>
  67 <dd><b>
  68 cvs -d:pserver:silc@silc.pspt.fi:/storage/silc/CVS login
  69 </b>
  70 <dd><b>
  71 cvs -d:pserver:silc@silc.pspt.fi:/storage/silc/CVS co silc
  72 </b>
  73
  74 <p>
  75 What ever method you decide to use, after you have done cvs login you will
  76 be prompted for password:
  77 <p>
  78 <dd><b>CVS password: </b>silc
  79 <p>
  80 Type the password "silc" and press Enter.
  81
  82 <p>
  83 The actual SILC source tree is checked out using the cvs co silc command,
  84 described above. This command will fetch the source tree and save it into
  85 directory named silc. SILC CVS repository currently does not have any
  86 branches thus this will check out the trunk. The size of the trunk is
  87 currently about 11 MB but will grow in the future.
  88
  89 <p><br>
  90 <h1>What SILC Source Tree Includes</h1>
  91 <p>
  92 SILC Source tree includes a lot more stuff that appears in public
  93 distribution.  The source tree includes, for example, internal scripts,
  94 configuration files, SILC webpages etc.  These never appear on a public
  95 distribution.
  96 <p>
  97 Following directories currently exist in SILC source tree.
  98 <p>
  99 <font size=3>
 100 <pre>
 101   doc/
 102
 103         Includes all the SILC documentation.  Some of the documentation
 104         are generated when distribution is generated.  The automatically
 105         generated files must never be commited to CVS.
 106
 107   includes/
 108
 109         Includes SILC include files.
 110
 111   lib/
 112
 113         Includes SILC libraries.  There maybe libraries on the CVS that
 114         does not appear on public distribution.
 115
 116   public_html/
 117
 118         Includes the official SILC web pages and everything that relates
 119         to them.  This directory never appears on public distribution.
 120
 121   silc/
 122
 123         Includes SILC client.  There can be some extra files that will
 124         never appear in public distribution, such as, configuration files.
 125
 126   silcd/
 127
 128         Includes SILC server.  There can be some extra files that will
 129         never appear in public distribution, such as, configuration files.
 130 </pre>
 131
 132 <font size=4>
 133
 134 <p><br>
 135 <h1>Howto Compile SILC Source Tree</h1>
 136 <p>
 137 After checkout from CVS the SILC source tree must be prepared for
 138 configuration and compilation.  To compile the source three, give,
 139 <p>
 140 <font size=3>
 141 <pre>
 142         ./prepare
 143         ./configure --enable-debug
 144         make
 145 </pre>
 146 <font size=4>
 147
 148 The ./prepare script is included in to the source tree and it never
 149 appears in public distribution.  The script prepares the source tree
 150 by creating configuration scripts and Makefiles.  The prepare must be
 151 run every time you make some changes to configuration scripts (however,
 152 making changes to Makefile.am's does not require running ./prepare).
 153
 154 <p>
 155 As a developer you should read the ./configure script's help by
 156 giving ./configure --help and study all of its different options.  Also,
 157 you should configure the script with --enable-debug option as it
 158 compiles SILC with -g (debugging) option and it enables the
 159 SILC_LOG_DEBUG* scripts.  Warning is due here:  The debugging produced
 160 by both cilent and server is very heavy, thus it is common to test
 161 the programs as follows:
 162 <p>
 163 <font size=3>
 164 <pre>
 165         ./silc -f configfile 2>log
 166         ./silcd -f configfile 2>log
 167 </pre>
 168 <font size=4>
 169
 170 <p><br>
 171 <h1>Howto Clean SILC Source Tree</h1>
 172 <p>
 173 To entirely clear the source tree to the state after it was checked out
 174 from CVS, give,
 175 <font size=3>
 176 <pre>
 177         ./prepare-clean
 178 </pre>
 179 <font size=4>
 180
 181 This calls `make distclean' plus removes automatically generated files
 182 by hand.  It also removes *.log files. However, it will not remove
 183 any other files you might have created.
 184
 185 <p><br>
 186 <h1>Makefiles and configuration files</h1>
 187 <p>
 188 Developers should never directly write a Makefile.  All Makefiles are
 189 always automatically generated by ./prepare and later by ./configure
 190 scripts.  Instead, developers must write Makefile.am files.  There
 191 are plenty of examples what they should look like.  If you change
 192 Makefile.am during development you don't have to run ./prepare, just
 193 run normal make.
 194 <p>
 195 Configuration files are the files that ./prepare automatically generates
 196 and what will be included into public distribution.  ./prepare creates
 197 for example the ./configure script that is not commited to the CVS.
 198 `configure.in' is the file that developers must edit to change ./configure
 199 script.  After changing one must run  ./prepare.
 200 <p><br>
 201 </td>
 202 </tr>
 203 </table>
 204 </body>
 205 </html>