<HTML
><HEAD
><TITLE
>The CVS Repository</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><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"></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"
></A
>2. The CVS Repository</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"
></A
>2.1. Access to CVS</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"
></A
>2.2. CVS Commit Guideline</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: <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>never, ever</I
></SPAN
>) 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 <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 (see below).
</P
></LI
><LI
><P
> Don't commit into the stable branch, unless immediately before a new
release. (See <A
HREF="newrelease.html#VERSIONNUMBERS"
>Version Numbers</A
> below
for details.) Collect your changes on the <A
HREF="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse"
TARGET="_top"
>patches
tracker</A
> instead.
</P
></LI
></UL
>
</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="CVSWHENASK"
></A
>2.3. Discussing Changes First</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 bug-fix / 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
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"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Documentation Guidelines</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
