doc/webserver/developer-manual/cvs.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >The CVS Repository</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
   8 REL="HOME"
   9 TITLE="Privoxy Developer Manual"
  10 HREF="index.html"><LINK
  11 REL="PREVIOUS"
  12 TITLE="Introduction"
  13 HREF="introduction.html"><LINK
  14 REL="NEXT"
  15 TITLE="Documentation Guidelines"
  16 HREF="documentation.html"><LINK
  17 REL="STYLESHEET"
  18 TYPE="text/css"
  19 HREF="../p_doc.css"></HEAD
  20 ><BODY
  21 CLASS="SECT1"
  22 BGCOLOR="#EEEEEE"
  23 TEXT="#000000"
  24 LINK="#0000FF"
  25 VLINK="#840084"
  26 ALINK="#0000FF"
  27 ><DIV
  28 CLASS="NAVHEADER"
  29 ><TABLE
  30 WIDTH="100%"
  31 BORDER="0"
  32 CELLPADDING="0"
  33 CELLSPACING="0"
  34 ><TR
  35 ><TH
  36 COLSPAN="3"
  37 ALIGN="center"
  38 >Privoxy Developer Manual</TH
  39 ></TR
  40 ><TR
  41 ><TD
  42 WIDTH="10%"
  43 ALIGN="left"
  44 VALIGN="bottom"
  45 ><A
  46 HREF="introduction.html"
  47 >Prev</A
  48 ></TD
  49 ><TD
  50 WIDTH="80%"
  51 ALIGN="center"
  52 VALIGN="bottom"
  53 ></TD
  54 ><TD
  55 WIDTH="10%"
  56 ALIGN="right"
  57 VALIGN="bottom"
  58 ><A
  59 HREF="documentation.html"
  60 >Next</A
  61 ></TD
  62 ></TR
  63 ></TABLE
  64 ><HR
  65 ALIGN="LEFT"
  66 WIDTH="100%"></DIV
  67 ><DIV
  68 CLASS="SECT1"
  69 ><H1
  70 CLASS="SECT1"
  71 ><A
  72 NAME="CVS"
  73 >2. The CVS Repository</A
  74 ></H1
  75 ><P
  76 >      If you intend to help us with programming, documentation or packaging
  77       you will need write access to our holy grail, the CVS repository.
  78       Please read this chapter completely before accessing via CVS.
  79     </P
  80 ><DIV
  81 CLASS="SECT2"
  82 ><H2
  83 CLASS="SECT2"
  84 ><A
  85 NAME="CVSACCESS"
  86 >2.1. Access to CVS</A
  87 ></H2
  88 ><P
  89 >        The project's CVS repository is hosted on
  90         <A
  91 HREF="http://sourceforge.net/"
  92 TARGET="_top"
  93 >SourceForge.</A
  94 >
  95         Please refer to the chapters 6 and 7 in
  96         <A
  97 HREF="http://sourceforge.net/docman/?group_id=1"
  98 TARGET="_top"
  99 >SF's site
 100         documentation</A
 101 > for the technical access details for your
 102         operating system. For historical reasons, the CVS server is
 103         called <TT
 104 CLASS="LITERAL"
 105 >cvs.ijbswa.sourceforge.net</TT
 106 >, the repository is
 107         called <TT
 108 CLASS="LITERAL"
 109 >ijbswa</TT
 110 >, and the source tree module is called
 111         <TT
 112 CLASS="LITERAL"
 113 >current</TT
 114 >.
 115       </P
 116 ></DIV
 117 ><DIV
 118 CLASS="SECT2"
 119 ><H2
 120 CLASS="SECT2"
 121 ><A
 122 NAME="CVSCOMMIT"
 123 >2.2. CVS Commit Guideline</A
 124 ></H2
 125 ><P
 126 >        The source tree is the heart of every software project. Every effort must
 127         be made to ensure that it is readable, compilable and consistent at all
 128         times. We therefore ask anyone with CVS access to strictly adhere to the
 129         following guidelines:
 130         <P
 131 ></P
 132 ><UL
 133 ><LI
 134 ><P
 135 >            Never (read: <I
 136 CLASS="EMPHASIS"
 137 >never, ever</I
 138 >) be tempted to commit
 139             that small change without testing it thoroughly first. When we're
 140             close to a public release, ask a fellow developer to review your
 141             changes.
 142           </P
 143 ></LI
 144 ><LI
 145 ><P
 146 >            Your commit message should give a concise overview of <I
 147 CLASS="EMPHASIS"
 148 >what you
 149             changed</I
 150 > (no big details) and <I
 151 CLASS="EMPHASIS"
 152 >why you changed it</I
 153 >
 154             Just check previous messages for good examples.
 155           </P
 156 ></LI
 157 ><LI
 158 ><P
 159 >            Don't use the same message on multiple files, unless it equally applies to
 160             all those files.
 161           </P
 162 ></LI
 163 ><LI
 164 ><P
 165 >            If your changes span multiple files, and the code won't recompile unless
 166             all changes are committed (e.g. when changing the signature of a function),
 167             then commit all files one after another, without long delays in between.
 168             If necessary, prepare the commit messages in advance.
 169           </P
 170 ></LI
 171 ><LI
 172 ><P
 173 >            Before changing things on CVS, make sure that your changes are in line
 174             with the team's general consensus on what should be done (see below).
 175           </P
 176 ></LI
 177 ><LI
 178 ><P
 179 >            Don't commit into the stable branch, unless immediately before a new
 180             release. (See <A
 181 HREF="newrelease.html#VERSIONNUMBERS"
 182 >Version Numbers</A
 183 > below
 184             for details.) Collect your changes on the <A
 185 HREF="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse"
 186 TARGET="_top"
 187 >patches
 188             tracker</A
 189 > instead.
 190           </P
 191 ></LI
 192 ></UL
 193 >
 194       </P
 195 ></DIV
 196 ><DIV
 197 CLASS="SECT2"
 198 ><H2
 199 CLASS="SECT2"
 200 ><A
 201 NAME="CVSWHENASK"
 202 >2.3. Discussing Changes First</A
 203 ></H2
 204 ><P
 205 >        We don't have a too formal policy on this, just use common sense. Hints: If it is..
 206         <P
 207 ></P
 208 ><OL
 209 TYPE="1"
 210 ><LI
 211 ><P
 212 >            ..a bug-fix / clean-up / cosmetic thing: shoot
 213           </P
 214 ></LI
 215 ><LI
 216 ><P
 217 >            ..a new feature that can be turned off: shoot
 218           </P
 219 ></LI
 220 ><LI
 221 ><P
 222 >            ..a clear improvement w/o side effects on other parts of the code: shoot
 223           </P
 224 ></LI
 225 ><LI
 226 ><P
 227 >            ..a matter of taste: <A
 228 HREF="mailto:developers@privoxy.org"
 229 TARGET="_top"
 230 >ask the list</A
 231 >
 232           </P
 233 ></LI
 234 ><LI
 235 ><P
 236 >            ..a major redesign of some part of the code: <A
 237 HREF="mailto:developers@privoxy.org"
 238 TARGET="_top"
 239 >ask
 240             the list</A
 241 >
 242           </P
 243 ></LI
 244 ></OL
 245 >
 246       </P
 247 ><P
 248 >        Note that near a major public release, we get a bit more cautious - if
 249         unsure, it doesn't hurt to ask first. There is always the possibility
 250         to submit a patch to the <A
 251 HREF="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse"
 252 TARGET="_top"
 253 >patches
 254         tracker</A
 255 > instead.
 256       </P
 257 ></DIV
 258 ></DIV
 259 ><DIV
 260 CLASS="NAVFOOTER"
 261 ><HR
 262 ALIGN="LEFT"
 263 WIDTH="100%"><TABLE
 264 WIDTH="100%"
 265 BORDER="0"
 266 CELLPADDING="0"
 267 CELLSPACING="0"
 268 ><TR
 269 ><TD
 270 WIDTH="33%"
 271 ALIGN="left"
 272 VALIGN="top"
 273 ><A
 274 HREF="introduction.html"
 275 >Prev</A
 276 ></TD
 277 ><TD
 278 WIDTH="34%"
 279 ALIGN="center"
 280 VALIGN="top"
 281 ><A
 282 HREF="index.html"
 283 >Home</A
 284 ></TD
 285 ><TD
 286 WIDTH="33%"
 287 ALIGN="right"
 288 VALIGN="top"
 289 ><A
 290 HREF="documentation.html"
 291 >Next</A
 292 ></TD
 293 ></TR
 294 ><TR
 295 ><TD
 296 WIDTH="33%"
 297 ALIGN="left"
 298 VALIGN="top"
 299 >Introduction</TD
 300 ><TD
 301 WIDTH="34%"
 302 ALIGN="center"
 303 VALIGN="top"
 304 >&nbsp;</TD
 305 ><TD
 306 WIDTH="33%"
 307 ALIGN="right"
 308 VALIGN="top"
 309 >Documentation Guidelines</TD
 310 ></TR
 311 ></TABLE
 312 ></DIV
 313 ></BODY
 314 ></HTML
 315 >