+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Privoxy Developer Manual</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.64
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="NEXT"
TITLE="Introduction"
HREF="introduction.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1"></HEAD
><BODY
CLASS="ARTICLE"
BGCOLOR="#EEEEEE"
NAME="AEN2"
>Privoxy Developer Manual</A
></H1
-><DIV
-CLASS="AUTHORGROUP"
-><A
-NAME="AEN5"
-></A
-><H3
-CLASS="AUTHOR"
-><A
-NAME="AEN6"
-></A
-></H3
-><DIV
-CLASS="AFFILIATION"
-><SPAN
-CLASS="ORGNAME"
->By: Privoxy Developers<BR></SPAN
-></DIV
-></DIV
><P
CLASS="PUBDATE"
->$Id: developer-manual.sgml,v 1.28 2002/04/08 22:59:26 hal9 Exp $<BR></P
+> <SUB
+>
+
+ <A
+HREF="copyright.html"
+>Copyright</A
+> © 2001-2009 by
+ <A
+HREF="http://www.privoxy.org/"
+TARGET="_top"
+>Privoxy Developers</A
+>
+ </SUB
+>
+ <BR></P
+><P
+CLASS="PUBDATE"
+>$Id: developer-manual.sgml,v 2.34 2010/11/06 12:55:48 fabiankeil Exp $<BR></P
><DIV
><DIV
CLASS="ABSTRACT"
+><P
+></P
><A
NAME="AEN9"
></A
><P
-></P
-><P
->
- </P
-><P
-> The developer manual gives the users information on how to help the developer
- team. It provides guidance on coding, testing, documentation and other
- issues.
- </P
-><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is a web proxy with advanced filtering
- capabilities for protecting privacy, filtering web page content, managing
- cookies, controlling access, and removing ads, banners, pop-ups and other
- obnoxious Internet junk. <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> has a very
- flexible configuration and can be customized to suit individual needs and
- tastes. <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> has application for both
- stand-alone systems and multi-user networks.</P
-><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is based on the code of the
- <SPAN
-CLASS="APPLICATION"
->Internet Junkbuster</SPAN
-> (tm).
+> The developer manual provides guidance on coding, testing, packaging, documentation
+ and other issues of importance to those involved with
<SPAN
CLASS="APPLICATION"
->Junkbuster</SPAN
-> was originally written by Junkbusters
- Corporation, and was released as free open-source software under the GNU GPL.
- Stefan Waldherr made many improvements, and started the SourceForge project
- to continue development.</P
-><P
-> <SPAN
-CLASS="APPLICATION"
>Privoxy</SPAN
-> continues the
- <SPAN
-CLASS="APPLICATION"
->Junkbuster</SPAN
-> tradition, but adds many
- refinements, enhancements and new features.</P
+> development. It is mandatory (and helpful!) reading
+ for anyone who wants to join the team. Note that it's currently out of date
+ and may not be entirely correct. As always, patches are welcome.</P
><P
-> You can find the latest version of the this manual at <A
+> Please note that this document is constantly evolving. This copy represents
+ the state at the release of version 3.0.17.
+ You can find the latest version of the this manual at <A
HREF="http://www.privoxy.org/developer-manual/"
TARGET="_top"
>http://www.privoxy.org/developer-manual/</A
>.
- Please see the Contact section on how to contact the developers.</P
+ Please see <A
+HREF="contact.html"
+>the Contact section</A
+>
+ on how to contact the developers.</P
><P
></P
></DIV
>Table of Contents</B
></DT
><DT
-><A
-HREF="index.html#INTRO"
-></A
-></DT
-><DT
>1. <A
HREF="introduction.html"
>Introduction</A
></DT
+><DD
+><DL
><DT
-HREF="quickstart.html"
+HREF="introduction.html#QUICKSTART"
>Quickstart to Privoxy Development</A
></DT
+></DL
+></DD
><DT
->4. <A
+>2. <A
+HREF="cvs.html"
+>The CVS Repository</A
+></DT
+><DD
+><DL
+><DT
+>2.1. <A
+HREF="cvs.html#CVSACCESS"
+>Access to CVS</A
+></DT
+><DT
+>2.2. <A
+HREF="cvs.html#CVSBRANCHES"
+>Branches</A
+></DT
+><DT
+>2.3. <A
+HREF="cvs.html#CVSCOMMIT"
+>CVS Commit Guidelines</A
+></DT
+></DL
+></DD
+><DT
+>3. <A
HREF="documentation.html"
>Documentation Guidelines</A
></DT
><DD
><DL
><DT
HREF="documentation.html#SGML"
>Quickstart to Docbook and SGML</A
></DT
><DT
HREF="documentation.html#DOCSTYLE"
><SPAN
CLASS="APPLICATION"
> Documentation Style</A
></DT
><DT
-HREF="documentation.html#AEN179"
+HREF="documentation.html#AEN217"
>Privoxy Custom Entities</A
></DT
></DL
></DD
><DT
HREF="coding.html"
>Coding Guidelines</A
></DT
><DD
><DL
><DT
HREF="coding.html#S1"
>Introduction</A
></DT
><DT
HREF="coding.html#S2"
>Using Comments</A
></DT
><DD
><DL
><DT
HREF="coding.html#S3"
>Comment, Comment, Comment</A
></DT
><DT
HREF="coding.html#S4"
>Use blocks for comments</A
></DT
><DT
HREF="coding.html#S5"
>Keep Comments on their own line</A
></DT
><DT
HREF="coding.html#S6"
>Comment each logical step</A
></DT
><DT
HREF="coding.html#S7"
>Comment All Functions Thoroughly</A
></DT
><DT
HREF="coding.html#S8"
>Comment at the end of braces if the
content is more than one screen length</A
></DL
></DD
><DT
HREF="coding.html#S9"
>Naming Conventions</A
></DT
><DD
><DL
><DT
HREF="coding.html#S10"
>Variable Names</A
></DT
><DT
HREF="coding.html#S11"
>Function Names</A
></DT
><DT
HREF="coding.html#S12"
>Header file prototypes</A
></DT
><DT
HREF="coding.html#S13"
>Enumerations, and #defines</A
></DT
><DT
HREF="coding.html#S14"
>Constants</A
></DT
></DL
></DD
><DT
HREF="coding.html#S15"
>Using Space</A
></DT
><DD
><DL
><DT
HREF="coding.html#S16"
>Put braces on a line by themselves.</A
></DT
><DT
HREF="coding.html#S17"
>ALL control statements should have a
block</A
></DT
><DT
HREF="coding.html#S18"
>Do not belabor/blow-up boolean
expressions</A
></DT
><DT
HREF="coding.html#S19"
>Use white space freely because it is
free</A
></DT
><DT
HREF="coding.html#S20"
>Don't use white space around structure
operators</A
></DT
><DT
HREF="coding.html#S21"
>Make the last brace of a function stand
out</A
></DT
><DT
HREF="coding.html#S22"
>Use 3 character indentions</A
></DT
></DL
></DD
><DT
HREF="coding.html#S23"
>Initializing</A
></DT
><DD
><DL
><DT
HREF="coding.html#S24"
>Initialize all variables</A
></DT
></DL
></DD
><DT
HREF="coding.html#S25"
>Functions</A
></DT
><DD
><DL
><DT
HREF="coding.html#S26"
>Name functions that return a boolean as a
question.</A
></DT
><DT
HREF="coding.html#S27"
>Always specify a return type for a
function.</A
></DT
><DT
HREF="coding.html#S28"
>Minimize function calls when iterating by
using variables</A
></DT
><DT
HREF="coding.html#S29"
>Pass and Return by Const Reference</A
></DT
><DT
HREF="coding.html#S30"
>Pass and Return by Value</A
></DT
><DT
HREF="coding.html#S31"
>Names of include files</A
></DT
><DT
HREF="coding.html#S32"
>Provide multiple inclusion
protection</A
></DT
><DT
HREF="coding.html#S33"
>Use `extern "C"` when appropriate</A
></DT
><DT
HREF="coding.html#S34"
>Where Possible, Use Forward Struct
Declaration Instead of Includes</A
></DL
></DD
><DT
HREF="coding.html#S35"
>General Coding Practices</A
></DT
><DD
><DL
><DT
HREF="coding.html#S36"
>Turn on warnings</A
></DT
><DT
HREF="coding.html#S37"
>Provide a default case for all switch
statements</A
></DT
><DT
HREF="coding.html#S38"
>Try to avoid falling through cases in a
switch statement.</A
></DT
><DT
HREF="coding.html#S39"
>Use 'long' or 'short' Instead of
'int'</A
></DT
><DT
HREF="coding.html#S40"
>Don't mix size_t and other types</A
></DT
><DT
HREF="coding.html#S41"
>Declare each variable and struct on its
own line.</A
></DT
><DT
HREF="coding.html#S42"
>Use malloc/zalloc sparingly</A
></DT
><DT
HREF="coding.html#S43"
>The Programmer Who Uses 'malloc' is
Responsible for Ensuring 'free'</A
></DT
><DT
HREF="coding.html#S44"
>Add loaders to the `file_list' structure
and in order</A
></DT
><DT
HREF="coding.html#S45"
>"Uncertain" new code and/or changes to
- exitinst code, use FIXME</A
+ existing code, use FIXME or XXX</A
></DT
></DL
></DD
><DT
HREF="coding.html#S46"
>Addendum: Template for files and function
comment blocks:</A
></DL
></DD
><DT
->6. <A
-HREF="cvs.html"
->Version Control Guidelines</A
-></DT
-><DT
->7. <A
+>5. <A
HREF="testing.html"
>Testing Guidelines</A
></DT
><DD
><DL
><DT
HREF="testing.html#TESTING-PLAN"
>Testplan for releases</A
></DT
><DT
HREF="testing.html#TESTING-REPORT"
>Test reports</A
></DT
></DL
></DD
><DT
HREF="newrelease.html"
->Releasing a new version</A
+>Releasing a New Version</A
></DT
><DD
><DL
><DT
->8.1. <A
+>6.1. <A
+HREF="newrelease.html#VERSIONNUMBERS"
+>Version numbers</A
+></DT
+><DT
+>6.2. <A
HREF="newrelease.html#BEFORERELEASE"
->Before the Release</A
+>Before the Release: Freeze</A
></DT
><DT
-HREF="newrelease.html#NEWRELEASE-WEB"
->Update the webserver</A
+HREF="newrelease.html#THERELEASE"
+>Building and Releasing the Packages</A
></DT
+><DD
+><DL
><DT
->8.3. <A
+>6.3.1. <A
+HREF="newrelease.html#PACK-GUIDELINES"
+>Note on Privoxy Packaging</A
+></DT
+><DT
+>6.3.2. <A
+HREF="newrelease.html#NEWRELEASE-TARBALL"
+>Source Tarball</A
+></DT
+><DT
+>6.3.3. <A
HREF="newrelease.html#NEWRELEASE-RPM"
->SuSE or Red Hat</A
+>SuSE, Conectiva or Red Hat RPM</A
></DT
><DT
HREF="newrelease.html#NEWRELEASE-OS2"
>OS/2</A
></DT
><DT
HREF="newrelease.html#NEWRELEASE-SOLARIS"
>Solaris</A
></DT
><DT
HREF="newrelease.html#NEWRELEASE-WINDOWS"
>Windows</A
></DT
><DT
HREF="newrelease.html#NEWRELEASE-DEBIAN"
>Debian</A
></DT
><DT
HREF="newrelease.html#NEWRELEASE-MACOSX"
->Mac OSX</A
+>Mac OS X</A
></DT
><DT
HREF="newrelease.html#NEWRELEASE-FREEBSD"
>FreeBSD</A
></DT
><DT
->8.10. <A
-HREF="newrelease.html#NEWRELEASE-TARBALL"
->Tarball</A
-></DT
-><DT
->8.11. <A
+>6.3.10. <A
HREF="newrelease.html#NEWRELEASE-HPUX"
>HP-UX 11</A
></DT
><DT
HREF="newrelease.html#NEWRELEASE-AMIGA"
>Amiga OS</A
></DT
><DT
HREF="newrelease.html#NEWRELEASE-AIX"
>AIX</A
></DT
></DL
></DD
><DT
->9. <A
+>6.4. <A
+HREF="newrelease.html#RELEASING"
+>Uploading and Releasing Your Package</A
+></DT
+><DT
+>6.5. <A
+HREF="newrelease.html#AFTERRELEASE"
+>After the Release</A
+></DT
+></DL
+></DD
+><DT
+>7. <A
+HREF="webserver-update.html"
+>Update the Webserver</A
+></DT
+><DT
+>8. <A
HREF="contact.html"
>Contacting the developers, Bug Reporting and Feature Requests</A
></DT
+><DD
+><DL
><DT
->10. <A
+>8.1. <A
+HREF="contact.html#CONTACT-SUPPORT"
+>Get Support</A
+></DT
+><DT
+>8.2. <A
+HREF="contact.html#REPORTING"
+>Reporting Problems</A
+></DT
+><DD
+><DL
+><DT
+>8.2.1. <A
+HREF="contact.html#CONTACT-ADS"
+>Reporting Ads or Other Configuration Problems</A
+></DT
+><DT
+>8.2.2. <A
+HREF="contact.html#CONTACT-BUGS"
+>Reporting Bugs</A
+></DT
+></DL
+></DD
+><DT
+>8.3. <A
+HREF="contact.html#CONTACT-FEATURE"
+>Request New Features</A
+></DT
+><DT
+>8.4. <A
+HREF="contact.html#CONTACT-OTHER"
+>Other</A
+></DT
+></DL
+></DD
+><DT
+>9. <A
HREF="copyright.html"
->Copyright and History</A
+>Privoxy Copyright, License and History</A
></DT
><DD
><DL
><DT
-HREF="copyright.html#AEN936"
->Copyright</A
+HREF="copyright.html#AEN1227"
+>License</A
></DT
><DT
-HREF="copyright.html#AEN943"
+HREF="copyright.html#AEN1243"
>History</A
></DT
></DL
></DD
><DT
HREF="seealso.html"
>See also</A
></DT
></DL
></DIV
-><DIV
-CLASS="SECT1"
-><H1
-CLASS="SECT1"
-><A
-NAME="INTRO"
-></A
-></H1
-><P
-> </P
-></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="introduction.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
></DIV
></BODY
></HTML
->
\ No newline at end of file
+>
projects / privoxy.git / blobdiff