public_html/cvs.php

   1 <b>Anonymous CVS access</b>
   2 <font size="2">
   3 <p>
   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
   9 of this web page.
  10 <p>
  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.
  15
  16 <p><br>
  17
  18 <b>Browsing the Source Tree</b>
  19 <p>
  20 If you want to browse the source tree using web browser before checking
  21 out the tree with CVS use following link:
  22 <p>
  23 <a href="cvs/source/">Web Access to CVS repository
  24 </a>
  25 <p>
  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
  28 repository.
  29
  30 <p><br>
  31
  32 <b>Howto Checkout The Source Tree</b>
  33 <p>
  34 The repository can be checked out by using anonymous pserver with CVS.
  35 <p>
  36 For those who are using sh/ksh/bash the check out is done as follows:
  37 <p>
  38 <font size="3">
  39 <tt>
  40 export CVSROOT=:pserver:silc@silc.pspt.fi:/storage/silc/CVS
  41 <p>
  42 cvs login<br>
  43 cvs co silc<br>
  44 </tt>
  45 </font>
  46
  47 <p>
  48 For those who are using csh/tcsh the check out is done as follows:
  49 <p>
  50 <font size="3">
  51 <tt>
  52 setenv CVSROOT :pserver:silc@silc.pspt.fi:/storage/silc/CVS
  53 <p>
  54 cvs login<br>
  55 cvs co silc<br>
  56 </tt>
  57 </font>
  58 <p>
  59 If you don't want to set $CVSROOT environment variable you can set the
  60 path to the cvs as command line options:
  61 <p>
  62 <font size="3">
  63 <tt>
  64 cvs -d:pserver:silc@silc.pspt.fi:/storage/silc/CVS login<br>
  65 cvs -d:pserver:silc@silc.pspt.fi:/storage/silc/CVS co silc
  66 </tt>
  67 </font>
  68 <p>
  69 What ever method you decide to use, after you have done cvs login you will
  70 be prompted for password:
  71 <p>
  72 <b>CVS password: </b>silc
  73 <p>
  74 Type the password "silc" and press Enter.
  75 <p>
  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 11 MB but will grow in the future.
  81
  82 <p><br>
  83
  84 <b>What SILC Source Tree Includes</b>
  85 <p>
  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
  89 distribution.
  90 <p>
  91 Following directories currently exist in SILC source tree.
  92 <p>
  93 <font size="3">
  94 <tt>
  95 doc/
  96 <ul>
  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.
 100 </ul>
 101 includes/
 102 <ul>
 103 Includes SILC include files.
 104 </ul>
 105 lib/
 106 <ul>
 107 Includes SILC libraries.  There maybe libraries on the CVS that
 108 does not appear on public distribution.
 109 </ul>
 110 public_html/
 111 <ul>
 112 Includes the official SILC web pages and everything that relates
 113 to them.  This directory never appears on public distribution.
 114 </ul>
 115 silc/
 116 <ul>
 117 Includes SILC client.  There can be some extra files that will
 118 never appear in public distribution, such as, configuration files.
 119 </ul>
 120 silcd/
 121 <ul>
 122 Includes SILC server.  There can be some extra files that will
 123 never appear in public distribution, such as, configuration files.
 124 </ul>
 125 </tt>
 126 </font>
 127
 128 <p><br>
 129
 130 <b>Howto Compile SILC Source Tree</b>
 131 <p>
 132 After checkout from CVS the SILC source tree must be prepared for
 133 configuration and compilation.  To compile the source tree, give,
 134 <p>
 135 <font size="3">
 136 <tt>
 137 ./prepare<br>
 138 ./configure --enable-debug<br>
 139 make
 140 </tt>
 141 </font>
 142 <p>
 143
 144 The ./prepare script is included in to the source tree and it never
 145 appears in public distribution.  The script prepares the source tree
 146 by creating configuration scripts and Makefiles.  The prepare must be
 147 run every time you make some changes to configuration scripts (however,
 148 making changes to Makefile.am's does not require running ./prepare).
 149 <p>
 150 As a developer you should read the ./configure script's help by
 151 giving ./configure --help and study all of its different options.  Also,
 152 you should configure the script with --enable-debug option as it
 153 compiles SILC with -g (debugging) option and it enables the
 154 SILC_LOG_DEBUG* scripts.  Warning is due here:  The debugging produced
 155 by both cilent and server is very heavy, thus it is common to test
 156 the programs as follows:
 157 <p>
 158 <font size="3">
 159 <tt>
 160 ./silc -d -f configfile 2&gt;log<br>
 161 ./silcd -d -f configfile 2&gt;log
 162 </tt>
 163 </font>
 164
 165 <p><br>
 166
 167 <b>Howto Clean SILC Source Tree</b>
 168 <p>
 169 To entirely clear the source tree to the state after it was checked out
 170 from CVS, give,
 171 <p>
 172 <font size="3">
 173 <tt>
 174 ./prepare-clean
 175 </tt>
 176 </font><p>
 177
 178 This calls `make distclean' plus removes automatically generated files
 179 by hand.  It also removes *.log files. However, it will not remove
 180 any other files you might have created.
 181
 182 <p><br>
 183
 184 <b>Makefiles and configuration files</b>
 185 <p>
 186 Developers should never directly write a Makefile.  All Makefiles are
 187 always automatically generated by ./prepare and later by ./configure
 188 scripts.  Instead, developers must write Makefile.am files.  There
 189 are plenty of examples what they should look like.  If you change
 190 Makefile.am during development you don't have to run ./prepare, just
 191 run normal make.
 192 <p>
 193 Configuration files are the files that ./prepare automatically generates
 194 and what will be included into public distribution.  ./prepare creates
 195 for example the ./configure script that is not commited to the CVS.
 196 `configure.in' is the file that developers must edit to change ./configure
 197 script.  After changing one must run  ./prepare.
 198 </font><p>