1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
2 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
8 <meta name="GENERATOR" content=
9 "Modular DocBook HTML Stylesheet Version 1.79">
10 <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
11 <link rel="PREVIOUS" title="Introduction" href="introduction.html">
12 <link rel="NEXT" title="Documentation Guidelines" href=
14 <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
15 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
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">
23 <th colspan="3" align="center">
24 Privoxy Developer Manual
28 <td width="10%" align="left" valign="bottom">
29 <a href="introduction.html" accesskey="P">Prev</a>
31 <td width="80%" align="center" valign="bottom">
33 <td width="10%" align="right" valign="bottom">
34 <a href="documentation.html" accesskey="N">Next</a>
38 <hr align="LEFT" width="100%">
42 <a name="CVS">2. The CVS Repository</a>
45 If you become part of the active development team, you will
46 eventually need write access to our holy grail, the CVS repository.
47 One of the team members will need to set this up for you. Please read
48 this chapter completely before accessing via CVS.
52 <a name="CVSACCESS">2.1. Access to CVS</a>
55 The project's CVS repository is hosted on <a href=
56 "https://sourceforge.net/" target="_top">SourceForge.</a> For
57 historical reasons, the CVS server is called <tt class=
58 "LITERAL">ijbswa.cvs.sourceforge.net</tt>, the repository is called
59 <tt class="LITERAL">ijbswa</tt>, and the source tree module is
60 called <tt class="LITERAL">current</tt>.
65 <a name="CVSBRANCHES">2.2. Branches</a>
68 Within the CVS repository, there are modules and branches. As
69 mentioned, the sources are in the <tt class="LITERAL">current</tt>
70 <span class="QUOTE">"module"</span>. Other modules are present for
71 platform specific issues. There is a webview of the CVS hierarchy
72 at <a href="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/"
73 target="_top">http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</a>,
74 which might help with visualizing how these pieces fit together.
77 At one time there were two distinct branches: stable and unstable.
78 The more drastic changes were to be in the unstable branch. These
79 branches have now been merged to minimize time and effort of
80 maintaining two branches.
85 <a name="CVSCOMMIT">2.3. CVS Commit Guidelines</a>
88 The source tree is the heart of every software project. Every
89 effort must be made to ensure that it is readable, compilable and
90 consistent at all times. We expect anyone with CVS access to
91 strictly adhere to the following guidelines:
94 Basic Guidelines, for all branches:
101 Please don't commit even a small change without testing it
102 thoroughly first. When we're close to a public release, ask a
103 fellow developer to review your changes.
108 Your commit message should give a concise overview of <span
109 class="emphasis"><i class="EMPHASIS">what you
110 changed</i></span> (no big details) and <span class=
111 "emphasis"><i class="EMPHASIS">why you changed it</i></span>
112 Just check previous messages for good examples.
117 Don't use the same message on multiple files, unless it equally
118 applies to all those files.
123 If your changes span multiple files, and the code won't
124 recompile unless all changes are committed (e.g. when changing
125 the signature of a function), then commit all files one after
126 another, without long delays in between. If necessary, prepare
127 the commit messages in advance.
132 Before changing things on CVS, make sure that your changes are
133 in line with the team's general consensus on what should be
139 Note that near a major public release, we get more cautious.
140 There is always the possibility to submit a patch to the <a
142 "https://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse"
143 target="_top">patch tracker</a> instead.
149 <div class="NAVFOOTER">
150 <hr align="LEFT" width="100%">
151 <table summary="Footer navigation table" width="100%" border="0"
152 cellpadding="0" cellspacing="0">
154 <td width="33%" align="left" valign="top">
155 <a href="introduction.html" accesskey="P">Prev</a>
157 <td width="34%" align="center" valign="top">
158 <a href="index.html" accesskey="H">Home</a>
160 <td width="33%" align="right" valign="top">
161 <a href="documentation.html" accesskey="N">Next</a>
165 <td width="33%" align="left" valign="top">
168 <td width="34%" align="center" valign="top">
171 <td width="33%" align="right" valign="top">
172 Documentation Guidelines