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