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 ></UL
 178 >
 179       </P
 180 ></DIV
 181 ><DIV
 182 CLASS="SECT2"
 183 ><H2
 184 CLASS="SECT2"
 185 ><A
 186 NAME="CVSWHENASK"
 187 >2.3. Discussing Changes First</A
 188 ></H2
 189 ><P
 190 >        We don't have a too formal policy on this, just use common sense. Hints: If it is..
 191         <P
 192 ></P
 193 ><OL
 194 TYPE="1"
 195 ><LI
 196 ><P
 197 >            ..a bug-fix / clean-up / cosmetic thing: shoot
 198           </P
 199 ></LI
 200 ><LI
 201 ><P
 202 >            ..a new feature that can be turned off: shoot
 203           </P
 204 ></LI
 205 ><LI
 206 ><P
 207 >            ..a clear improvement w/o side effects on other parts of the code: shoot
 208           </P
 209 ></LI
 210 ><LI
 211 ><P
 212 >            ..a matter of taste: <A
 213 HREF="mailto:developers@privoxy.org"
 214 TARGET="_top"
 215 >ask the list</A
 216 >
 217           </P
 218 ></LI
 219 ><LI
 220 ><P
 221 >            ..a major redesign of some part of the code: <A
 222 HREF="mailto:developers@privoxy.org"
 223 TARGET="_top"
 224 >ask
 225             the list</A
 226 >
 227           </P
 228 ></LI
 229 ></OL
 230 >
 231       </P
 232 ><P
 233 >        Note that near a major public release, we get a bit more cautious - if
 234         unsure, it doesn't hurt to ask first. There is always the possibility
 235         to submit a patch to the <A
 236 HREF="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse"
 237 TARGET="_top"
 238 >patches
 239         tracker</A
 240 > instead.
 241       </P
 242 ></DIV
 243 ></DIV
 244 ><DIV
 245 CLASS="NAVFOOTER"
 246 ><HR
 247 ALIGN="LEFT"
 248 WIDTH="100%"><TABLE
 249 WIDTH="100%"
 250 BORDER="0"
 251 CELLPADDING="0"
 252 CELLSPACING="0"
 253 ><TR
 254 ><TD
 255 WIDTH="33%"
 256 ALIGN="left"
 257 VALIGN="top"
 258 ><A
 259 HREF="introduction.html"
 260 >Prev</A
 261 ></TD
 262 ><TD
 263 WIDTH="34%"
 264 ALIGN="center"
 265 VALIGN="top"
 266 ><A
 267 HREF="index.html"
 268 >Home</A
 269 ></TD
 270 ><TD
 271 WIDTH="33%"
 272 ALIGN="right"
 273 VALIGN="top"
 274 ><A
 275 HREF="documentation.html"
 276 >Next</A
 277 ></TD
 278 ></TR
 279 ><TR
 280 ><TD
 281 WIDTH="33%"
 282 ALIGN="left"
 283 VALIGN="top"
 284 >Introduction</TD
 285 ><TD
 286 WIDTH="34%"
 287 ALIGN="center"
 288 VALIGN="top"
 289 >&nbsp;</TD
 290 ><TD
 291 WIDTH="33%"
 292 ALIGN="right"
 293 VALIGN="top"
 294 >Documentation Guidelines</TD
 295 ></TR
 296 ></TABLE
 297 ></DIV
 298 ></BODY
 299 ></HTML
 300 >