doc/webserver/developer-manual/cvs.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2 "http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4 <head>
   5   <title>The CVS Repository</title>
   6   <meta name="GENERATOR" content=
   7   "Modular DocBook HTML Stylesheet Version 1.79">
   8   <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
   9   <link rel="PREVIOUS" title="Introduction" href="introduction.html">
  10   <link rel="NEXT" title="Documentation Guidelines" href=
  11   "documentation.html">
  12   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  14 </head>
  15 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
  16 "#840084" alink="#0000FF">
  17   <div class="NAVHEADER">
  18     <table summary="Header navigation table" width="100%" border="0"
  19     cellpadding="0" cellspacing="0">
  20       <tr>
  21         <th colspan="3" align="center">Privoxy Developer Manual</th>
  22       </tr>
  23       <tr>
  24         <td width="10%" align="left" valign="bottom"><a href=
  25         "introduction.html" accesskey="P">Prev</a></td>
  26         <td width="80%" align="center" valign="bottom"></td>
  27         <td width="10%" align="right" valign="bottom"><a href=
  28         "documentation.html" accesskey="N">Next</a></td>
  29       </tr>
  30     </table>
  31     <hr align="left" width="100%">
  32   </div>
  33   <div class="SECT1">
  34     <h1 class="SECT1"><a name="CVS" id="CVS">2. The CVS Repository</a></h1>
  35     <p>If you become part of the active development team, you will eventually
  36     need write access to our holy grail, the CVS repository. One of the team
  37     members will need to set this up for you. Please read this chapter
  38     completely before accessing via CVS.</p>
  39     <div class="SECT2">
  40       <h2 class="SECT2"><a name="CVSACCESS" id="CVSACCESS">2.1. Access to
  41       CVS</a></h2>
  42       <p>The project's CVS repository is hosted on <a href=
  43       "https://sourceforge.net/" target="_top">SourceForge.</a> For
  44       historical reasons, the CVS server is called <tt class=
  45       "LITERAL">ijbswa.cvs.sourceforge.net</tt>, the repository is called
  46       <tt class="LITERAL">ijbswa</tt>, and the source tree module is called
  47       <tt class="LITERAL">current</tt>.</p>
  48     </div>
  49     <div class="SECT2">
  50       <h2 class="SECT2"><a name="CVSBRANCHES" id="CVSBRANCHES">2.2.
  51       Branches</a></h2>
  52       <p>Within the CVS repository, there are modules and branches. As
  53       mentioned, the sources are in the <tt class="LITERAL">current</tt>
  54       <span class="QUOTE">"module"</span>. Other modules are present for
  55       platform specific issues. There is a webview of the CVS hierarchy at
  56       <a href="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/" target=
  57       "_top">http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</a>, which
  58       might help with visualizing how these pieces fit together.</p>
  59       <p>At one time there were two distinct branches: stable and unstable.
  60       The more drastic changes were to be in the unstable branch. These
  61       branches have now been merged to minimize time and effort of
  62       maintaining two branches.</p>
  63     </div>
  64     <div class="SECT2">
  65       <h2 class="SECT2"><a name="CVSCOMMIT" id="CVSCOMMIT">2.3. CVS Commit
  66       Guidelines</a></h2>
  67       <p>The source tree is the heart of every software project. Every effort
  68       must be made to ensure that it is readable, compilable and consistent
  69       at all times. We expect anyone with CVS access to strictly adhere to
  70       the following guidelines:</p>
  71       <p>Basic Guidelines, for all branches:</p>
  72       <ul>
  73         <li>
  74           <p>Please don't commit even a small change without testing it
  75           thoroughly first. When we're close to a public release, ask a
  76           fellow developer to review your changes.</p>
  77         </li>
  78         <li>
  79           <p>Your commit message should give a concise overview of
  80           <span class="emphasis"><i class="EMPHASIS">what you
  81           changed</i></span> (no big details) and <span class=
  82           "emphasis"><i class="EMPHASIS">why you changed it</i></span> Just
  83           check previous messages for good examples.</p>
  84         </li>
  85         <li>
  86           <p>Don't use the same message on multiple files, unless it equally
  87           applies to all those files.</p>
  88         </li>
  89         <li>
  90           <p>If your changes span multiple files, and the code won't
  91           recompile unless all changes are committed (e.g. when changing the
  92           signature of a function), then commit all files one after another,
  93           without long delays in between. If necessary, prepare the commit
  94           messages in advance.</p>
  95         </li>
  96         <li>
  97           <p>Before changing things on CVS, make sure that your changes are
  98           in line with the team's general consensus on what should be
  99           done.</p>
 100         </li>
 101         <li>
 102           <p>Note that near a major public release, we get more cautious.
 103           There is always the possibility to submit a patch to the <a href=
 104           "https://sourceforge.net/tracker/?atid=311118&amp;group_id=11118&amp;func=browse"
 105           target="_top">patch tracker</a> instead.</p>
 106         </li>
 107       </ul>
 108     </div>
 109   </div>
 110   <div class="NAVFOOTER">
 111     <hr align="left" width="100%">
 112     <table summary="Footer navigation table" width="100%" border="0"
 113     cellpadding="0" cellspacing="0">
 114       <tr>
 115         <td width="33%" align="left" valign="top"><a href="introduction.html"
 116         accesskey="P">Prev</a></td>
 117         <td width="34%" align="center" valign="top"><a href="index.html"
 118         accesskey="H">Home</a></td>
 119         <td width="33%" align="right" valign="top"><a href=
 120         "documentation.html" accesskey="N">Next</a></td>
 121       </tr>
 122       <tr>
 123         <td width="33%" align="left" valign="top">Introduction</td>
 124         <td width="34%" align="center" valign="top">&nbsp;</td>
 125         <td width="33%" align="right" valign="top">Documentation
 126         Guidelines</td>
 127       </tr>
 128     </table>
 129   </div>
 130 </body>
 131 </html>