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