1 #include "top.h"
2 #include "cvs.h"
3 #include "bodytop.h"
4 #include "navbar.h"
5 </*>
6    <h3>What is CVS?</h3>
7 
8    <blockquote>
9      CVS is a source code repository maintenance system, which allows a group of
10      developers located at distant places to work on the same source code over
11      the internet.  This sounds complicated at first, but using CVS is really
12      easy, even if you have never used it before.  If you want to contribute to
13      the Husky project (and be it only for making some bug fixes from time to
14      time), we suggest you install CVS and get a login to our CVS server.
15      If you would simply like to browse the CVS repository, in order to do that online,
16      go to <a href="http://husky.cvs.sourceforge.net/husky/">http://husky.cvs.sourceforge.net/husky/</a>.
17 
18      <p>
19      In the following, you can see a very little introduction
20      how CVS works and how you should and can use it, once you have gotten your
21      account.  If you want to know CVS in more detail, please also read the
22      documentation (info-pages) of CVS. They are very instructive.
23 
24      <ul>
25      <li><i>Note:</i> This description only covers the command line version of CVS.
26     However, if you are using a GUI version, the steps are the same, but there
27     might be some differences and problems.
28      <li>All CVS commands require a connection to the CVS server.
29      <li><a href="http://www.cvshome.org/dev/codes.html">Get CVS</a>&nbsp;for
30     your platform and install it. Please be sure to use at least version 1.10.
31     <dir><small>Note for windows users:<br>
32     Please use&nbsp;<a href="http://www.cygwin.com">cygwin</a>&nbsp;version of CVS
33     if possible - to prevent unexpected CR-CRLF translation.
34     </small></dir>
35     Do not use CVS under different platforms on the same work source tree.<br>
36     Do not use one working directory for more then one CVS connection.
37      <li>Recommended settings for CVS (add to .cvsrc in your home directory):<br>
38     <CODE>&nbsp;&nbsp;cvs -z3<BR>
39     &nbsp;&nbsp;checkout -P<BR>
40     &nbsp;&nbsp;update -P -d<BR>
41     &nbsp;&nbsp;diff -c </CODE>
42 
43      <li>Read-only access:
44          <p>
45          If You have only retrieve and install latest sources follow the following procedure:
46          <p>
47          <blockquote>
48          <kbd>cvs -d:pserver:anonymous@husky.cvs.sourceforge.net:/cvsroot/husky login</kbd>
49          </blockquote>
50          and press <kbd>enter</kbd> where the <kbd>password:</kbd> prompted.
51          (Login required for first cvs connect to this repository only.)
52          <blockquote>
53          <kbd>cvs -z3 -d:pserver:anonymous@husky.cvs.sourceforge.net:/cvsroot/husky co smapi fidoconf ...</kbd>
54          </blockquote>
55          to retrieve libraries and needed programs or<br>
56          <blockquote>
57          <kbd>cvs -z9 -d:pserver:anonymous@husky.cvs.sourceforge.net:/cvsroot/husky co .</kbd>
58          </blockquote>
59          to retrieve all modules.
60          </p>
61 
62          <p>
63          To update existing sources tree use cvs <kbd>up</kbd> command instead <kbd>co</kbd>.
64          </p>
65 
66          <p>
67          Check the file ChangeLog for infrmation about source changes.
68          If you upgrade a cvs version then always do a make clean before
69          you get the next version from the cvs server. If you do not then
70          in some cases there will be problems.  It is also possible to browse
71          the cvs repository to get individual files.</p>
72 
73      <li>Read-write access:
74        <ul>
75          <li>If you want to use the CVS server with write access (you is
76          developer), register self into
77          sourceforge.net and write mail to husky project manager, currently
78          <a href="mailto:stas_degteff@users.sourceforge.net">Stas Degteff</a>
79          <li>Read <a href="https://sourceforge.net/cvs/?group_id=1332">Project: husky: CVS</a>
80          page and doing as here write.
81          <br>(Set the environment variable CVS_RSH to <kbd>ssh</kbd> and Use
82          cvsroot <kbd>:ext:<i>&lt;developername&gt;</i>@husky.cvs.husky.sourceforge.net:/cvsroot/husky</kbd>
83          using '-d' cvs option or set the environment variable CVSROOT to.)
84        </ul>
85      <li>Get your work source tree:
86        <ul>
87          <li>Type <kbd>cvs co .</kbd> to checkout the latest version of the husky
88          source tree of all modules on the cvs-server. A new directory for any
89          module will be created in the current directory containing the sources.
90          <li>Type <kbd>cvs co <i>&lt;module&gt;</i> [...] </kbd> for one
91          or more modules. To get a list of all modules type: <kbd>cvs history .
92          </kbd>
93        </ul>
94      <li>Do your modifications:
95        <ul>
96          <li>Please group them together to match one log message. Do not do thousands
97          of completely different modifications that do not depend on each other.
98          As CVS saves the log message you enter with every file you have modified
99          it is not very clever to do a long list of changes.<br>
100          I.E., if you want to implement a new feature and fix a bug in an already
101          existing module that is independent to the new feature, first fix the
102          bug and commit the changes (see below) and then implement the new feature.
103         <li>Make sure your sources are compileable!
104       </ul>
105     <li>To see what you or others have changed:
106       <ul>
107         <li>If you want to review the changes you have done type <KBD>cvs diff</KBD>
108         . This will create a diff file. If you are using the above settings it
109         will create a context diff which is IMHO easier to read. <BR>
110         <li>You can also use <KBD>cvs diff <I>&lt;file&gt;</I> [...]</KBD> to only
111         see the changes of the file(s) you have specified.
112       </ul>
113     <li>Update your work source tree:
114       <ul>
115         <li>Type <KBD>cvs up</KBD> in the root directory of your work source tree
116         to update it. This is only necessary when other developers committed changes.
117         <BR>
118         <li>If there were conflicts, you will be notified by CVS and you have to
119         resolve them by hand. CVS will save the two conflicting parts and mark
120         them for you.
121       </ul>
122     <li>Commit your changes: (only non-anonymous users)
123       <ul>
124         <li>Type <KBD>cvs ci [<I>&lt;file&gt;</I> [...]]</KBD> to commit your changes.
125         If you use <KBD>cvs ci</KBD> in the root directory of your work source
126         tree, all modified files will be committed. <BR>
127         <li>You will be asked for a log entry. Please read the notes in the template
128         and enter a detailed description. This description will also be used in
129         the changes.log.<BR>
130         <I>Note:</I> if you are using a GUI version of CVS that does not use "<CODE>CVS:</CODE>"
131         to mark comments in a template, you must remove all lines starting with
132         "<CODE>CVS:</CODE>" by hand.
133         <li>If you forget to update and another developer committed changes to the
134         same file, your commit will be rejected.
135       </ul>
136     </ul>
137 
138 
139       <p align="center">
140       <small>Thanks to <a href="mailto:mr@uue.org">Michael Reinsch</A> fom BTXE developers team for the original.</small>
141       </p>
142 
143       <small>Last update: 13/12/2006</small>
144 <!--*/>
145 #include "bottom.h"
146