Rebuild HTML docs after adding the sponsor policy
[privoxy.git] / doc / webserver / developer-manual / cvs.html
index e78d185..3262477 100644 (file)
-<HTML
-><HEAD
-><TITLE
->The CVS Repository</TITLE
-><META
-NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.64
-"><LINK
-REL="HOME"
-TITLE="Privoxy Developer Manual"
-HREF="index.html"><LINK
-REL="PREVIOUS"
-TITLE="Quickstart to Privoxy Development"
-HREF="quickstart.html"><LINK
-REL="NEXT"
-TITLE="Documentation Guidelines"
-HREF="documentation.html"><LINK
-REL="STYLESHEET"
-TYPE="text/css"
-HREF="../p_doc.css"></HEAD
-><BODY
-CLASS="SECT1"
-BGCOLOR="#EEEEEE"
-TEXT="#000000"
-LINK="#0000FF"
-VLINK="#840084"
-ALINK="#0000FF"
-><DIV
-CLASS="NAVHEADER"
-><TABLE
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TH
-COLSPAN="3"
-ALIGN="center"
->Privoxy Developer Manual</TH
-></TR
-><TR
-><TD
-WIDTH="10%"
-ALIGN="left"
-VALIGN="bottom"
-><A
-HREF="quickstart.html"
->Prev</A
-></TD
-><TD
-WIDTH="80%"
-ALIGN="center"
-VALIGN="bottom"
-></TD
-><TD
-WIDTH="10%"
-ALIGN="right"
-VALIGN="bottom"
-><A
-HREF="documentation.html"
->Next</A
-></TD
-></TR
-></TABLE
-><HR
-ALIGN="LEFT"
-WIDTH="100%"></DIV
-><DIV
-CLASS="SECT1"
-><H1
-CLASS="SECT1"
-><A
-NAME="CVS"
->4. The CVS Repository</A
-></H1
-><P
->      If you intend to help us with programming, documentation or packaging
-      you will need write access to our holy grail, the CVS repository.
-      Please read this chapter completely before accessing via CVS.
-    </P
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="CVSACCESS"
->4.1. Access to CVS</A
-></H2
-><P
->        The project's CVS repository is hosted on
-        <A
-HREF="http://sourceforge.net/"
-TARGET="_top"
->SourceForge.</A
->
-        Please refer to the chapters 6 and 7 in
-        <A
-HREF="http://sourceforge.net/docman/?group_id=1"
-TARGET="_top"
->SF's site
-        documentation</A
-> for the technical access details for your
-        operating system. For historical reasons, the CVS server is
-        called <TT
-CLASS="LITERAL"
->cvs.ijbswa.sourceforge.net</TT
->, the repository is
-        called <TT
-CLASS="LITERAL"
->ijbswa</TT
->, and the source tree module is called
-        <TT
-CLASS="LITERAL"
->current</TT
->.
-      </P
-></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="CVSCOMMIT"
->4.2. CVS Commit Guideline</A
-></H2
-><P
->        The source tree is the heart of every software project. Every effort must
-        be made to ensure that it is readable, compilable and consistent at all
-        times. We therefore ask anyone with CVS access to strictly adhere to the
-        following guidelines:
-        <P
-></P
-><UL
-><LI
-><P
->            Never (read: <I
-CLASS="EMPHASIS"
->never, ever</I
->) be tempted to commit
-            that small change without testing it thoroughly first. When we're
-            close to a public release, ask a fellow developer to review your 
-            changes.
-          </P
-></LI
-><LI
-><P
->            Your commit message should give a concise overview of <I
-CLASS="EMPHASIS"
->what you
-            changed</I
-> (no big details) and <I
-CLASS="EMPHASIS"
->why you changed it</I
->
-            Just check previous messages for good examples.
-          </P
-></LI
-><LI
-><P
->            Don't use the same message on multiple files, unless it equally applies to
-            all those files.
-          </P
-></LI
-><LI
-><P
->            If your changes span multiple files, and the code won't recompile unless
-            all changes are commited (e.g. when changing the signature of a function),
-            then commit all files one after another, without long delays in beween.
-            If necessary, prepare the commit messages in advance.
-          </P
-></LI
-><LI
-><P
->            Before changing things on CVS, make sure that your changes are in line
-            with the team's general consensus on what should be done (see below).
-          </P
-></LI
-></UL
->
-      </P
-></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="CVSWHENASK"
->4.3. Discussing Changes First</A
-></H2
-><P
->        We don't have a too formal policy on this, just use common sense. Hints: If it is..
-        <P
-></P
-><OL
-TYPE="1"
-><LI
-><P
->            ..a bugfix / clean-up / cosmetic thing: shoot
-          </P
-></LI
-><LI
-><P
->            ..a new feature that can be turned off: shoot
-          </P
-></LI
-><LI
-><P
->            ..a clear improvement w/o side effects on other parts of the code: shoot
-          </P
-></LI
-><LI
-><P
->            ..a matter of taste: <A
-HREF="mailto:developers@privoxy.org"
-TARGET="_top"
->ask the list</A
->
-          </P
-></LI
-><LI
-><P
->            ..a major redesign of some part of the code: <A
-HREF="mailto:developers@privoxy.org"
-TARGET="_top"
->ask
-            the list</A
->
-          </P
-></LI
-></OL
->
-      </P
-><P
->        Note that near a major public release, we get a bit more cautious - if
-        unsure, it doesn't hurt to ask first. There is always the possibility
-        to submit a patch to the <A
-HREF="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse"
-TARGET="_top"
->patches
-        tracker</A
-> instead.
-      </P
-></DIV
-></DIV
-><DIV
-CLASS="NAVFOOTER"
-><HR
-ALIGN="LEFT"
-WIDTH="100%"><TABLE
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
-><A
-HREF="quickstart.html"
->Prev</A
-></TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
-><A
-HREF="index.html"
->Home</A
-></TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
-><A
-HREF="documentation.html"
->Next</A
-></TD
-></TR
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
->Quickstart to Privoxy Development</TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
->&nbsp;</TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
->Documentation Guidelines</TD
-></TR
-></TABLE
-></DIV
-></BODY
-></HTML
->
\ No newline at end of file
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
+Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+    <title>
+      The CVS Repository
+    </title>
+    <meta name="GENERATOR" content=
+    "Modular DocBook HTML Stylesheet Version 1.79">
+    <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
+    <link rel="PREVIOUS" title="Introduction" href="introduction.html">
+    <link rel="NEXT" title="Documentation Guidelines" href=
+    "documentation.html">
+    <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+  </head>
+  <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
+  "#840084" alink="#0000FF">
+    <div class="NAVHEADER">
+      <table summary="Header navigation table" width="100%" border="0"
+      cellpadding="0" cellspacing="0">
+        <tr>
+          <th colspan="3" align="center">
+            Privoxy Developer Manual
+          </th>
+        </tr>
+        <tr>
+          <td width="10%" align="left" valign="bottom">
+            <a href="introduction.html" accesskey="P">Prev</a>
+          </td>
+          <td width="80%" align="center" valign="bottom">
+          </td>
+          <td width="10%" align="right" valign="bottom">
+            <a href="documentation.html" accesskey="N">Next</a>
+          </td>
+        </tr>
+      </table>
+      <hr align="LEFT" width="100%">
+    </div>
+    <div class="SECT1">
+      <h1 class="SECT1">
+        <a name="CVS">2. The CVS Repository</a>
+      </h1>
+      <p>
+        If you become part of the active development team, you will
+        eventually need write access to our holy grail, the CVS repository.
+        One of the team members will need to set this up for you. Please read
+        this chapter completely before accessing via CVS.
+      </p>
+      <div class="SECT2">
+        <h2 class="SECT2">
+          <a name="CVSACCESS">2.1. Access to CVS</a>
+        </h2>
+        <p>
+          The project's CVS repository is hosted on <a href=
+          "https://sourceforge.net/" target="_top">SourceForge.</a> For
+          historical reasons, the CVS server is called <tt class=
+          "LITERAL">ijbswa.cvs.sourceforge.net</tt>, the repository is called
+          <tt class="LITERAL">ijbswa</tt>, and the source tree module is
+          called <tt class="LITERAL">current</tt>.
+        </p>
+      </div>
+      <div class="SECT2">
+        <h2 class="SECT2">
+          <a name="CVSBRANCHES">2.2. Branches</a>
+        </h2>
+        <p>
+          Within the CVS repository, there are modules and branches. As
+          mentioned, the sources are in the <tt class="LITERAL">current</tt>
+          <span class="QUOTE">"module"</span>. Other modules are present for
+          platform specific issues. There is a webview of the CVS hierarchy
+          at <a href="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/"
+          target="_top">http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</a>,
+          which might help with visualizing how these pieces fit together.
+        </p>
+        <p>
+          At one time there were two distinct branches: stable and unstable.
+          The more drastic changes were to be in the unstable branch. These
+          branches have now been merged to minimize time and effort of
+          maintaining two branches.
+        </p>
+      </div>
+      <div class="SECT2">
+        <h2 class="SECT2">
+          <a name="CVSCOMMIT">2.3. CVS Commit Guidelines</a>
+        </h2>
+        <p>
+          The source tree is the heart of every software project. Every
+          effort must be made to ensure that it is readable, compilable and
+          consistent at all times. We expect anyone with CVS access to
+          strictly adhere to the following guidelines:
+        </p>
+        <p>
+          Basic Guidelines, for all branches:
+        </p>
+        <p>
+        </p>
+        <ul>
+          <li>
+            <p>
+              Please don't commit even a small change without testing it
+              thoroughly first. When we're close to a public release, ask a
+              fellow developer to review your changes.
+            </p>
+          </li>
+          <li>
+            <p>
+              Your commit message should give a concise overview of <span
+              class="emphasis"><i class="EMPHASIS">what you
+              changed</i></span> (no big details) and <span class=
+              "emphasis"><i class="EMPHASIS">why you changed it</i></span>
+              Just check previous messages for good examples.
+            </p>
+          </li>
+          <li>
+            <p>
+              Don't use the same message on multiple files, unless it equally
+              applies to all those files.
+            </p>
+          </li>
+          <li>
+            <p>
+              If your changes span multiple files, and the code won't
+              recompile unless all changes are committed (e.g. when changing
+              the signature of a function), then commit all files one after
+              another, without long delays in between. If necessary, prepare
+              the commit messages in advance.
+            </p>
+          </li>
+          <li>
+            <p>
+              Before changing things on CVS, make sure that your changes are
+              in line with the team's general consensus on what should be
+              done.
+            </p>
+          </li>
+          <li>
+            <p>
+              Note that near a major public release, we get more cautious.
+              There is always the possibility to submit a patch to the <a
+              href=
+              "https://sourceforge.net/tracker/?atid=311118&amp;group_id=11118&amp;func=browse"
+               target="_top">patch tracker</a> instead.
+            </p>
+          </li>
+        </ul>
+      </div>
+    </div>
+    <div class="NAVFOOTER">
+      <hr align="LEFT" width="100%">
+      <table summary="Footer navigation table" width="100%" border="0"
+      cellpadding="0" cellspacing="0">
+        <tr>
+          <td width="33%" align="left" valign="top">
+            <a href="introduction.html" accesskey="P">Prev</a>
+          </td>
+          <td width="34%" align="center" valign="top">
+            <a href="index.html" accesskey="H">Home</a>
+          </td>
+          <td width="33%" align="right" valign="top">
+            <a href="documentation.html" accesskey="N">Next</a>
+          </td>
+        </tr>
+        <tr>
+          <td width="33%" align="left" valign="top">
+            Introduction
+          </td>
+          <td width="34%" align="center" valign="top">
+            &nbsp;
+          </td>
+          <td width="33%" align="right" valign="top">
+            Documentation Guidelines
+          </td>
+        </tr>
+      </table>
+    </div>
+  </body>
+</html>
+