public_html/html/cvs.php

   1 &nbsp;<br />
   2 <b><big>Anonymous CVS access</big></b>
   3 <br />&nbsp;<br />
   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 <br />&nbsp;<br />
  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 <br />&nbsp;<br />
  17
  18 <b>Browsing the Source Tree</b>
  19 <br />&nbsp;<br />
  20 If you want to browse the source tree using web browser before checking
  21 out the tree with CVS use following link:
  22 <br />&nbsp;<br />
  23 <a href="http://cvs.silcnet.org/" class="normal">Web Access to CVS repository
  24 </a>
  25 <br />&nbsp;<br />
  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 <br />&nbsp;<br />
  31
  32 <b>Howto Checkout The Source Tree</b>
  33 <br />&nbsp;<br />
  34 The repository can be checked out by using anonymous pserver with CVS.
  35 <br />&nbsp;<br />
  36 For those who are using sh/ksh/bash/zsh the check out is done as follows:
  37 <br />&nbsp;<br />
  38 <tt class="blue">
  39 export CVSROOT=:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?>
  40 <br />&nbsp;<br />
  41 cvs login<br />
  42 cvs co silc<br />
  43 cvs logout<br />
  44 </tt>
  45
  46 <br />&nbsp;<br />
  47 For those who are using csh/tcsh the check out is done as follows:
  48 <br />&nbsp;<br />
  49 <tt class="blue">
  50 setenv CVSROOT :pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?>
  51 <br />&nbsp;<br />
  52 cvs login<br />
  53 cvs co silc<br />
  54 cvs logout<br />
  55 </tt>
  56 <br />&nbsp;<br />
  57 If you don't want to set $CVSROOT environment variable you can set the
  58 path to the cvs as command line option:
  59 <br />&nbsp;<br />
  60 <tt class="blue">
  61 cvs -d:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?> login
  62 <br />
  63 cvs -d:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?> co silc
  64 <br />
  65 cvs -d:pserver:<?php printf("%s@%s:%s", $CVS_User, $CVS_Site, $CVS_Root); ?> logout
  66 </tt>
  67 <br />&nbsp;<br />
  68 Whatever method you will decide to use, after you have done cvs login you will
  69 be prompted for password:
  70 <br />&nbsp;<br />
  71 <b>CVS password: </b>silc
  72 <br />&nbsp;<br />
  73 Type the password "silc" and press &lt;ENTER&gt;
  74 <br />&nbsp;<br />
  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.
  80
  81 <br />&nbsp;<br />
  82
  83 <b>What SILC Source Tree Includes</b>
  84 <br />&nbsp;<br />
  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
  88 distribution.
  89 <br />&nbsp;<br />
  90 Following directories currently exist in SILC source tree.
  91 <br />&nbsp;<br />
  92 <tt class="blue">
  93 doc/
  94 <br />&nbsp;<br />
  95 &nbsp; Includes all the SILC documentation. Few parts of the documentation<br />
  96 &nbsp; are generated when distribution is generated. The automatically<br />
  97 &nbsp; generated files should never be commited to CVS.<br />
  98 <br />&nbsp;<br />
  99 includes/
 100 <br />&nbsp;<br />
 101 &nbsp; Includes SILC include files.
 102 <br />&nbsp;<br />
 103 lib/
 104 <br />&nbsp;<br />
 105 &nbsp; Includes SILC libraries. There are maybe libraries in the CVS which<br />
 106 &nbsp; are not inclduded in public distribution.<br />
 107 <br />&nbsp;<br />
 108 public_html/
 109 <br />&nbsp;<br />
 110 &nbsp; Includes the official SILC web pages and everything related to them.<br />
 111 &nbsp; This directory will never appear in public distribution.<br />
 112 <br />&nbsp;<br />
 113 silc/
 114 <br />&nbsp;<br />
 115 &nbsp; Includes SILC client. There can be some extra files that will<br />
 116 &nbsp; never appear in public distribution, such as configuration files.<br />
 117 <br />&nbsp;<br />
 118 silcd/
 119 <br />&nbsp;<br />
 120 &nbsp; Includes SILC server. There can be some extra files that will<br />
 121 &nbsp; never appear in public distribution, such as configuration files.<br />
 122 </tt>
 123
 124 <br />&nbsp;<br />
 125
 126 <b>Howto Compile SILC Source Tree</b>
 127 <br />&nbsp;<br />
 128 After checkout from CVS the SILC source tree needs to be prepared for
 129 configuration and compilation. To compile the source tree, type:
 130 <br />&nbsp;<br />
 131 <tt class="blue">
 132 ./prepare<br />
 133 ./configure --enable-debug<br />
 134 make<br />&nbsp;<br />
 135 note: on non-GNU/Linux operating systems GNU make (gmake) is prefered
 136 </tt>
 137 <br />&nbsp;<br />
 138
 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).
 144 <br />&nbsp;<br />
 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
 151 follows:
 152 <br />&nbsp;<br />
 153 <tt class="blue">
 154 ./silc -d -f configfile 2&gt;log<br />
 155 ./silcd -d -f configfile 2&gt;log
 156 </tt>
 157
 158 <br />&nbsp;<br />
 159
 160 <b>How to clean SILC Source Tree</b>
 161 <br />&nbsp;<br />
 162 To entirely clear the source tree to the state after it was checked out
 163 from CVS, type:
 164 <br />&nbsp;<br />
 165 <tt class="blue">
 166 ./prepare-clean
 167 </tt>
 168 <br />&nbsp;<br />
 169
 170 This calls `make distclean' plus removes automatically generated files
 171 by hand. It also removes *.log files. However, it will not remove any
 172 other files you might have created.
 173
 174 <br />&nbsp;<br />
 175
 176 <b>Makefiles and configuration files</b>
 177 <br />&nbsp;<br />
 178 Developers should never directly write a Makefile. All Makefiles are
 179 always automatically generated by ./prepare and later by ./configure
 180 scripts. Instead, developers have to write Makefile.am files. There
 181 are plenty of examples what they should look like. If you changed
 182 Makefile.am during development you do not need to run ./prepare, just
 183 run normal make.
 184 <br />&nbsp;<br />
 185 Configuration files are the files that ./prepare automatically generates
 186 and which will be included into public distribution. ./prepare creates
 187 for example the ./configure script that is not commited to the CVS.
 188 `configure.in' is the file that developers have to edit to change ./configure