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