Privoxy Developer Manual
-By: Privoxy Developers
+Copyright © 2001-2006 by Privoxy Developers
-$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $
+$Id: developer-manual.sgml,v 2.10 2006/09/22 01:27:55 hal9 Exp $
-The developer manual gives the users information on how to help the developer
-team. It provides guidance on coding, testing, documentation and other issues.
+The developer manual provides guidance on coding, testing, packaging,
+documentation and other issues of importance to those involved with Privoxy
+development. It is mandatory (and helpful!) reading for anyone who wants to
+join the team.
-Privoxy 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. Privoxy has a
-very flexible configuration and can be customized to suit individual needs and
-tastes. Privoxy has application for both stand-alone systems and multi-user
-networks.
-
-Privoxy is based on the code of the Internet Junkbuster (tm). Junkbuster 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.
-
-Privoxy continues the Junkbuster tradition, but adds many refinements,
-enhancements and new features.
-
-You can find the latest version of the this manual at http://www.privoxy.org/
-developer-manual/. Please see the Contact section on how to contact the
-developers.
+Please note that this document is constantly evolving. This copy represents the
+state at the release of version 3.0.5. You can find the latest version of the
+this manual at http://www.privoxy.org/developer-manual/. Please see the Contact
+section on how to contact the developers.
-------------------------------------------------------------------------------
Table of Contents
-
1. Introduction
-3. Quickstart to Privoxy Development
-4. Documentation Guidelines
- 4.1. Quickstart to Docbook and SGML
- 4.2. Privoxy Documentation Style
- 4.3. Privoxy Custom Entities
+ 1.1. Quickstart to Privoxy Development
+
+2. The CVS Repository
+
+ 2.1. Access to CVS
+ 2.2. Branches
+ 2.3. CVS Commit Guidelines
+
+3. Documentation Guidelines
+
+ 3.1. Quickstart to Docbook and SGML
+ 3.2. Privoxy Documentation Style
+ 3.3. Privoxy Custom Entities
-5. Coding Guidelines
+4. Coding Guidelines
- 5.1. Introduction
- 5.2. Using Comments
+ 4.1. Introduction
+ 4.2. Using Comments
- 5.2.1. Comment, Comment, Comment
- 5.2.2. Use blocks for comments
- 5.2.3. Keep Comments on their own line
- 5.2.4. Comment each logical step
- 5.2.5. Comment All Functions Thoroughly
- 5.2.6. Comment at the end of braces if the content is more than one
+ 4.2.1. Comment, Comment, Comment
+ 4.2.2. Use blocks for comments
+ 4.2.3. Keep Comments on their own line
+ 4.2.4. Comment each logical step
+ 4.2.5. Comment All Functions Thoroughly
+ 4.2.6. Comment at the end of braces if the content is more than one
screen length
- 5.3. Naming Conventions
+ 4.3. Naming Conventions
- 5.3.1. Variable Names
- 5.3.2. Function Names
- 5.3.3. Header file prototypes
- 5.3.4. Enumerations, and #defines
- 5.3.5. Constants
+ 4.3.1. Variable Names
+ 4.3.2. Function Names
+ 4.3.3. Header file prototypes
+ 4.3.4. Enumerations, and #defines
+ 4.3.5. Constants
- 5.4. Using Space
+ 4.4. Using Space
- 5.4.1. Put braces on a line by themselves.
- 5.4.2. ALL control statements should have a block
- 5.4.3. Do not belabor/blow-up boolean expressions
- 5.4.4. Use white space freely because it is free
- 5.4.5. Don't use white space around structure operators
- 5.4.6. Make the last brace of a function stand out
- 5.4.7. Use 3 character indentions
+ 4.4.1. Put braces on a line by themselves.
+ 4.4.2. ALL control statements should have a block
+ 4.4.3. Do not belabor/blow-up boolean expressions
+ 4.4.4. Use white space freely because it is free
+ 4.4.5. Don't use white space around structure operators
+ 4.4.6. Make the last brace of a function stand out
+ 4.4.7. Use 3 character indentions
- 5.5. Initializing
+ 4.5. Initializing
- 5.5.1. Initialize all variables
+ 4.5.1. Initialize all variables
- 5.6. Functions
+ 4.6. Functions
- 5.6.1. Name functions that return a boolean as a question.
- 5.6.2. Always specify a return type for a function.
- 5.6.3. Minimize function calls when iterating by using variables
- 5.6.4. Pass and Return by Const Reference
- 5.6.5. Pass and Return by Value
- 5.6.6. Names of include files
- 5.6.7. Provide multiple inclusion protection
- 5.6.8. Use `extern "C"` when appropriate
- 5.6.9. Where Possible, Use Forward Struct Declaration Instead of
+ 4.6.1. Name functions that return a boolean as a question.
+ 4.6.2. Always specify a return type for a function.
+ 4.6.3. Minimize function calls when iterating by using variables
+ 4.6.4. Pass and Return by Const Reference
+ 4.6.5. Pass and Return by Value
+ 4.6.6. Names of include files
+ 4.6.7. Provide multiple inclusion protection
+ 4.6.8. Use `extern "C"` when appropriate
+ 4.6.9. Where Possible, Use Forward Struct Declaration Instead of
Includes
- 5.7. General Coding Practices
+ 4.7. General Coding Practices
- 5.7.1. Turn on warnings
- 5.7.2. Provide a default case for all switch statements
- 5.7.3. Try to avoid falling through cases in a switch statement.
- 5.7.4. Use 'long' or 'short' Instead of 'int'
- 5.7.5. Don't mix size_t and other types
- 5.7.6. Declare each variable and struct on its own line.
- 5.7.7. Use malloc/zalloc sparingly
- 5.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
+ 4.7.1. Turn on warnings
+ 4.7.2. Provide a default case for all switch statements
+ 4.7.3. Try to avoid falling through cases in a switch statement.
+ 4.7.4. Use 'long' or 'short' Instead of 'int'
+ 4.7.5. Don't mix size_t and other types
+ 4.7.6. Declare each variable and struct on its own line.
+ 4.7.7. Use malloc/zalloc sparingly
+ 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
'free'
- 5.7.9. Add loaders to the `file_list' structure and in order
- 5.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
+ 4.7.9. Add loaders to the `file_list' structure and in order
+ 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
- 5.8. Addendum: Template for files and function comment blocks:
+ 4.8. Addendum: Template for files and function comment blocks:
-6. Version Control Guidelines
-7. Testing Guidelines
+5. Testing Guidelines
- 7.1. Testplan for releases
- 7.2. Test reports
+ 5.1. Testplan for releases
+ 5.2. Test reports
-8. Releasing a new version
+6. Releasing a New Version
- 8.1. Before the Release
- 8.2. Update the webserver
- 8.3. SuSE or Red Hat
- 8.4. OS/2
- 8.5. Solaris
- 8.6. Windows
- 8.7. Debian
- 8.8. Mac OSX
- 8.9. FreeBSD
- 8.10. Tarball
- 8.11. HP-UX 11
- 8.12. Amiga OS
- 8.13. AIX
+ 6.1. Version numbers
+ 6.2. Before the Release: Freeze
+ 6.3. Building and Releasing the Packages
+
+ 6.3.1. Note on Privoxy Packaging
+ 6.3.2. Source Tarball
+ 6.3.3. SuSE, Conectiva or Red Hat RPM
+ 6.3.4. OS/2
+ 6.3.5. Solaris
+ 6.3.6. Windows
+ 6.3.7. Debian
+ 6.3.8. Mac OSX
+ 6.3.9. FreeBSD
+ 6.3.10. HP-UX 11
+ 6.3.11. Amiga OS
+ 6.3.12. AIX
+
+ 6.4. Uploading and Releasing Your Package
+ 6.5. After the Release
-9. Contacting the developers, Bug Reporting and Feature Requests
-10. Copyright and History
+7. Update the Webserver
+8. Contacting the developers, Bug Reporting and Feature Requests
- 10.1. Copyright
- 10.2. History
+ 8.1. Get Support
+ 8.2. Reporting Problems
+
+ 8.2.1. Reporting Ads or Other Configuration Problems
+ 8.2.2. Reporting Bugs
+
+ 8.3. Request New Features
+ 8.4. Other
-11. See also
-
--------------------------------------------------------------------------------
+9. Privoxy Copyright, License and History
+
+ 9.1. License
+ 9.2. History
+
+10. See also
1. Introduction
-------------------------------------------------------------------------------
-3. Quickstart to Privoxy Development
+1.1. Quickstart to Privoxy Development
+
+The first step is to join the developer's mailing list. You can submit your
+ideas, or even better patches. Patches are best submitted to the Sourceforge
+tracker set up for this purpose, but can be sent to the list for review too.
+
+You will also need to have a cvs package installed, which will entail having
+ssh installed as well (which seems to be a requirement of SourceForge), in
+order to access the cvs repository. Having the GNU build tools is also going to
+be important (particularly, autoconf and gmake).
+
+For the time being (read, this section is under construction), you can also
+refer to the extensive comments in the source code. In fact, reading the code
+is recommended in any case.
+
+-------------------------------------------------------------------------------
+
+2. The CVS Repository
+
+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.
+
+-------------------------------------------------------------------------------
+
+2.1. Access to CVS
+
+The project's CVS repository is hosted on SourceForge. Please refer to the
+chapters 6 and 7 in SF's site documentation for the technical access details
+for your operating system. For historical reasons, the CVS server is called
+ijbswa.cvs.sourceforge.net, the repository is called ijbswa, and the source
+tree module is called current.
+
+-------------------------------------------------------------------------------
+
+2.2. Branches
+
+Within the CVS repository, there are modules and branches. As mentioned, the
+sources are in the current "module". Other modules are present for platform
+specific issues. There is a webview of the CVS hierarchy at http://
+ijbswa.cvs.sourceforge.net/ijbswa/, which might help with visualizing how these
+pieces fit together.
+
+Branches are used to fork a sub-development path from the main trunk. Within
+the current module where the sources are, there is always at least one "branch"
+from the main trunk devoted to a stable release series. The main trunk is where
+active development takes place for the next stable series (e.g. 3.2.x). So just
+prior to each stable series (e.g. 3.0.x), a branch is created just for stable
+series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc). Once the initial stable
+release of any stable branch has taken place, this branch is only used for
+bugfixes, which have had prior testing before being committed to CVS. (See
+Version Numbers below for details on versioning.)
+
+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.
+
+-------------------------------------------------------------------------------
+
+2.3. CVS Commit Guidelines
-You'll need an account on Sourceforge to support our development. Mail your ID
-to the list and wait until a project manager has added you.
+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.
+There are differing guidelines for the stable branch and the main development
+trunk, and we ask anyone with CVS access to strictly adhere to the following
+guidelines:
-For the time being (read, this section is under construction), please note the
-following guidelines for changing stuff in the code. If it is
+Basic Guidelines, for all branches:
- 1. A bugfix / clean-up / cosmetic thing: shoot
+ * 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.
- 2. A new feature that can be turned off: shoot
+ * Your commit message should give a concise overview of what you changed (no
+ big details) and why you changed it Just check previous messages for good
+ examples.
- 3. A clear improvement w/o side effects on other parts of the code: shoot
+ * Don't use the same message on multiple files, unless it equally applies to
+ all those files.
- 4. A matter of taste: ask the list
+ * 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.
- 5. A major redesign of some part of the code: ask the list
+ * Before changing things on CVS, make sure that your changes are in line with
+ the team's general consensus on what should be done.
+
+ * Note that near a major public release, we get more cautious. There is
+ always the possibility to submit a patch to the patch tracker instead.
-Note that near a major public release, we get a bit more cautious - if unsure,
-it doesn't hurt to ask first.
-
-------------------------------------------------------------------------------
-4. Documentation Guidelines
+3. Documentation Guidelines
All formal documents are maintained in Docbook SGML and located in the doc/
source/* directory. You will need Docbook, the Docbook DTD's and the Docbook
modular stylesheets (or comparable alternatives), and either jade or openjade
(recommended) installed in order to build docs from source. Currently there is
user-manual, FAQ, and, of course this, the developer-manual in this format. The
-README, AUTHORS privoxy.1 (man page) files are also now maintained as Docbook
-SGML. The finished files are all in the top-level source directory are
-generated files! Also, index.html, the Privoxy home page, is maintained as
-SGML. DO NOT edit these directly. Edit the SGML source, or contact someone
-involved in the documentation (at present Stefan and Hal).
-
-Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain
-text files in the top-level source directory. At least for the time being.
+README, AUTHORS, INSTALL, privoxy.1 (man page), and config files are also now
+maintained as Docbook SGML. These files, when built, in the top-level source
+directory are generated files! Also, the Privoxy index.html (and a variation on
+this file, privoxy-index.html, meant for inclusion with doc packages), are
+maintained as SGML as well. DO NOT edit these directly. Edit the SGML source,
+or contact someone involved in the documentation.
+
+config requires some special handling. The reason it is maintained this way is
+so that the extensive comments in the file mirror those in user-manual. But the
+conversion process requires going from SGML to HTML to text to special
+formatting required for the embedded comments. Some of this does not survive so
+well. Especially some of the examples that are longer than 80 characters. The
+build process for this file outputs to config.new, which should be reviewed for
+errors and mis-formatting. Once satisfied that it is correct, then it should be
+hand copied to config.
+
+Other, less formal documents (e.g. LICENSE) are maintained as plain text files
+in the top-level source directory.
Packagers are encouraged to include this documentation. For those without the
ability to build the docs locally, text versions of each are kept in CVS. HTML
-versions are also now being kept in CVS under doc/webserver/*.
+versions are also being kept in CVS under doc/webserver/*. And PDF version are
+kept in doc/pdf/*.
Formal documents are built with the Makefile targets of make dok, or
alternately make redhat-dok. If you have problems, try both. The build process
How do you update the webserver (i.e. the pages on privoxy.org)?
1. First, build the docs by running make dok (or alternately make redhat-dok).
+ For PDF docs, do make dok-pdf.
2. Run make webserver which copies all files from doc/webserver to the
sourceforge webserver via scp.
-------------------------------------------------------------------------------
-4.1. Quickstart to Docbook and SGML
+3.1. Quickstart to Docbook and SGML
If you are not familiar with SGML, it is a markup language similar to HTML.
Actually, not a mark up language per se, but a language used to define markup
Some common elements that you likely will use:
-, paragraph delimiter. Most text needs to be within paragraph elements (there
-are some exceptions).
-, the stylesheets make this italics.
-, files and directories.
-, command examples.
-, like
-, more or less.
-, list with bullets.
-, member of the above.
-, screen output, implies .
-, like HTML tag.
-, for, doh, quoting text.
+<para></para>, paragraph delimiter. Most text needs to be within paragraph
+elements (there are some exceptions).
+<emphasis></emphasis>, the stylesheets make this italics.
+<filename></filename>, files and directories.
+<command></command>, command examples.
+<literallayout></literallayout>, like <pre>, more or less.
+<itemizedlist></itemizedlist>, list with bullets.
+<listitem></listitem>, member of the above.
+<screen></screen>, screen output, implies <literallayout>.
+<ulink url="example.com"></ulink>, like HTML <a> tag.
+<quote></quote>, for, doh, quoting text.
Look at any of the existing docs for examples of all these and more.
+You might also find "Writing Documentation Using DocBook - A Crash Course"
+useful.
+
-------------------------------------------------------------------------------
-4.2. Privoxy Documentation Style
+3.2. Privoxy Documentation Style
It will be easier if everyone follows a similar writing style. This just makes
it easier to read what someone else has written if it is all done in a similar
instance.
* Our documents are available in differing formats. Right now, they are just
- plain text, and HTML, but PDF, and others is always a future possibility.
-
Be careful with URLs (<ulink>), and avoid this mistake:
+ plain text, HTML, and PDF, but others are always a future possibility. Be
+ careful with URLs (<ulink>), and avoid this mistake:
My favorite site is <ulink url="http://example.com">here</ulink>.
-------------------------------------------------------------------------------
-4.3. Privoxy Custom Entities
+3.3. Privoxy Custom Entities
Privoxy documentation is using a number of customized "entities" to facilitate
documentation maintenance.
* Commonly used "internal entities":
- p-version: the Privoxy version string, e.g. "2.9.14".
+ p-version: the Privoxy version string, e.g. "3.0.5".
p-status: the project status, either "alpha", "beta", or "stable".
p-not-stable: use to conditionally include text in "not stable" releases
(e.g. "beta").
-------------------------------------------------------------------------------
-5. Coding Guidelines
+4. Coding Guidelines
-5.1. Introduction
+4.1. Introduction
This set of standards is designed to make our lives easier. It is developed
with the simple goal of helping us keep the "new and improved Privoxy"
-------------------------------------------------------------------------------
-5.2. Using Comments
+4.2. Using Comments
-5.2.1. Comment, Comment, Comment
+4.2.1. Comment, Comment, Comment
Explanation:
-------------------------------------------------------------------------------
-5.2.2. Use blocks for comments
+4.2.2. Use blocks for comments
Explanation:
-------------------------------------------------------------------------------
-5.2.3. Keep Comments on their own line
+4.2.3. Keep Comments on their own line
Explanation:
-------------------------------------------------------------------------------
-5.2.4. Comment each logical step
+4.2.4. Comment each logical step
Explanation:
-------------------------------------------------------------------------------
-5.2.5. Comment All Functions Thoroughly
+4.2.5. Comment All Functions Thoroughly
Explanation:
-------------------------------------------------------------------------------
-5.2.6. Comment at the end of braces if the content is more than one screen
+4.2.6. Comment at the end of braces if the content is more than one screen
length
Explanation:
-------------------------------------------------------------------------------
-5.3. Naming Conventions
+4.3. Naming Conventions
-5.3.1. Variable Names
+4.3.1. Variable Names
Explanation:
-------------------------------------------------------------------------------
-5.3.2. Function Names
+4.3.2. Function Names
Explanation:
-------------------------------------------------------------------------------
-5.3.3. Header file prototypes
+4.3.3. Header file prototypes
Explanation:
-------------------------------------------------------------------------------
-5.3.4. Enumerations, and #defines
+4.3.4. Enumerations, and #defines
Explanation:
-------------------------------------------------------------------------------
-5.3.5. Constants
+4.3.5. Constants
Explanation:
-------------------------------------------------------------------------------
-5.4. Using Space
+4.4. Using Space
-5.4.1. Put braces on a line by themselves.
+4.4.1. Put braces on a line by themselves.
Explanation:
-------------------------------------------------------------------------------
-5.4.2. ALL control statements should have a block
+4.4.2. ALL control statements should have a block
Explanation:
-------------------------------------------------------------------------------
-5.4.3. Do not belabor/blow-up boolean expressions
+4.4.3. Do not belabor/blow-up boolean expressions
Example:
-------------------------------------------------------------------------------
-5.4.4. Use white space freely because it is free
+4.4.4. Use white space freely because it is free
Explanation:
-------------------------------------------------------------------------------
-5.4.5. Don't use white space around structure operators
+4.4.5. Don't use white space around structure operators
Explanation:
-------------------------------------------------------------------------------
-5.4.6. Make the last brace of a function stand out
+4.4.6. Make the last brace of a function stand out
Example:
-------------------------------------------------------------------------------
-5.4.7. Use 3 character indentions
+4.4.7. Use 3 character indentions
Explanation:
-------------------------------------------------------------------------------
-5.5. Initializing
+4.5. Initializing
-5.5.1. Initialize all variables
+4.5.1. Initialize all variables
Explanation:
-------------------------------------------------------------------------------
-5.6. Functions
+4.6. Functions
-5.6.1. Name functions that return a boolean as a question.
+4.6.1. Name functions that return a boolean as a question.
Explanation:
-------------------------------------------------------------------------------
-5.6.2. Always specify a return type for a function.
+4.6.2. Always specify a return type for a function.
Explanation:
-------------------------------------------------------------------------------
-5.6.3. Minimize function calls when iterating by using variables
+4.6.3. Minimize function calls when iterating by using variables
Explanation:
-------------------------------------------------------------------------------
-5.6.4. Pass and Return by Const Reference
+4.6.4. Pass and Return by Const Reference
Explanation:
-------------------------------------------------------------------------------
-5.6.5. Pass and Return by Value
+4.6.5. Pass and Return by Value
Explanation:
-------------------------------------------------------------------------------
-5.6.6. Names of include files
+4.6.6. Names of include files
Explanation:
Example:
-#include /* This is not a local include */
+#include <iostream.h> /* This is not a local include */
#include "config.h" /* This IS a local include */
Exception:
/* This is not a local include, but requires a path element. */
-#include
+#include <sys/fileName.h>
Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
This duplicates the #include "file.h" behavior.
-------------------------------------------------------------------------------
-5.6.7. Provide multiple inclusion protection
+4.6.7. Provide multiple inclusion protection
Explanation:
-------------------------------------------------------------------------------
-5.6.8. Use `extern "C"` when appropriate
+4.6.8. Use `extern "C"` when appropriate
Explanation:
-------------------------------------------------------------------------------
-5.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
+4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
Explanation:
-------------------------------------------------------------------------------
-5.7. General Coding Practices
+4.7. General Coding Practices
-5.7.1. Turn on warnings
+4.7.1. Turn on warnings
Explanation
-------------------------------------------------------------------------------
-5.7.2. Provide a default case for all switch statements
+4.7.2. Provide a default case for all switch statements
Explanation:
-------------------------------------------------------------------------------
-5.7.3. Try to avoid falling through cases in a switch statement.
+4.7.3. Try to avoid falling through cases in a switch statement.
Explanation:
-------------------------------------------------------------------------------
-5.7.4. Use 'long' or 'short' Instead of 'int'
+4.7.4. Use 'long' or 'short' Instead of 'int'
Explanation:
-------------------------------------------------------------------------------
-5.7.5. Don't mix size_t and other types
+4.7.5. Don't mix size_t and other types
Explanation:
-------------------------------------------------------------------------------
-5.7.6. Declare each variable and struct on its own line.
+4.7.6. Declare each variable and struct on its own line.
Explanation:
-------------------------------------------------------------------------------
-5.7.7. Use malloc/zalloc sparingly
+4.7.7. Use malloc/zalloc sparingly
Explanation:
-------------------------------------------------------------------------------
-5.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
+4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
Explanation:
instance is `free'd, even if the deallocation event falls within some other
programmer's code. You are also responsible for ensuring that deletion is
timely (i.e. not too soon, not too late). This is known as "low-coupling" and
-is a "good thing (tm)". You may need to offer a free/unload/destuctor type
+is a "good thing (tm)". You may need to offer a free/unload/destructor type
function to accommodate this.
Example:
-------------------------------------------------------------------------------
-5.7.9. Add loaders to the `file_list' structure and in order
+4.7.9. Add loaders to the `file_list' structure and in order
Explanation:
-------------------------------------------------------------------------------
-5.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
+4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
Explanation:
-------------------------------------------------------------------------------
-5.8. Addendum: Template for files and function comment blocks:
+4.8. Addendum: Template for files and function comment blocks:
Example for file comments:
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 2.10 2006/09/22 01:27:55 hal9 Exp $";
/*********************************************************************
*
* File : $Source$
*
* Purpose : (Fill me in with a good description!)
*
- * Copyright : Written by and Copyright (C) 2001 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001-2006 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* The GNU General Public License should be included with
* this file. If not, you can view it at
* http://www.gnu.org/copyleft/gpl.html
- * or write to the Free Software Foundation, Inc., 59
- * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
+ * USA
*
* Revisions :
* $Log$
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.10 2006/09/22 01:27:55 hal9 Exp $"
/*********************************************************************
*
* File : $Source$
*
* Purpose : (Fill me in with a good description!)
*
- * Copyright : Written by and Copyright (C) 2001 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001-2006 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* The GNU General Public License should be included with
* this file. If not, you can view it at
* http://www.gnu.org/copyleft/gpl.html
- * or write to the Free Software Foundation, Inc., 59
- * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
+ * USA
*
* Revisions :
* $Log$
-------------------------------------------------------------------------------
-6. Version Control Guidelines
-
-To be filled. note on cvs comments. Don't only comment what you did, but also
-why you did it!
-
--------------------------------------------------------------------------------
-
-7. Testing Guidelines
+5. Testing Guidelines
To be filled.
-------------------------------------------------------------------------------
-7.1. Testplan for releases
+5.1. Testplan for releases
Explain release numbers. major, minor. developer releases. etc.
-------------------------------------------------------------------------------
-7.2. Test reports
+5.2. Test reports
Please submit test reports only with the test form at sourceforge. Three simple
steps:
* Fill the Summary and Detailed Description with something intelligent (keep
it short and precise).
-Do not mail to the mailinglist (we cannot keep track on issues there).
+Do not mail to the mailing list (we cannot keep track on issues there).
-------------------------------------------------------------------------------
-8. Releasing a new version
+6. Releasing a New Version
+
+When we release versions of Privoxy, our work leaves our cozy secret lab and
+has to work in the cold RealWorld[tm]. Once it is released, there is no way to
+call it back, so it is very important that great care is taken to ensure that
+everything runs fine, and not to introduce problems in the very last minute.
-To minimize trouble with distribution contents, web-page errors and the like,
-we strongly encourage you to follow this section if you prepare a new release
-of code or new pages on the webserver.
+So when releasing a new version, please adhere exactly to the procedure
+outlined in this chapter.
The following programs are required to follow this process: ncftpput (ncftp),
-scp (ssh), gmake (GNU's version of make), autoconf, cvs, ???.
+scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs.
+
+-------------------------------------------------------------------------------
+
+6.1. Version numbers
+
+First you need to determine which version number the release will have. Privoxy
+version numbers consist of three numbers, separated by dots, like in X.Y.Z
+(e.g. 3.0.0), where:
+
+ * X, the version major, is rarely ever changed. It is increased by one if
+ turning a development branch into stable substantially changes the
+ functionality, user interface or configuration syntax. Majors 1 and 2 were
+ Junkbuster, and 3 will be the first stable Privoxy release.
+
+ * Y, the version minor, represents the branch within the major version. At
+ any point in time, there are two branches being maintained: The stable
+ branch, with an even minor, say, 2N, in which no functionality is being
+ added and only bug-fixes are made, and 2N+1, the development branch, in
+ which the further development of Privoxy takes place. This enables us to
+ turn the code upside down and inside out, while at the same time providing
+ and maintaining a stable version. The minor is reset to zero (and one) when
+ the major is incremented. When a development branch has matured to the
+ point where it can be turned into stable, the old stable branch 2N is given
+ up (i.e. no longer maintained), the former development branch 2N+1 becomes
+ the new stable branch 2N+2, and a new development branch 2N+3 is opened.
+
+ * Z, the point or sub version, represents a release of the software within a
+ branch. It is therefore incremented immediately before each code freeze. In
+ development branches, only the even point versions correspond to actual
+ releases, while the odd ones denote the evolving state of the sources on
+ CVS in between. It follows that Z is odd on CVS in development branches
+ most of the time. There, it gets increased to an even number immediately
+ before a code freeze, and is increased to an odd number again immediately
+ thereafter. This ensures that builds from CVS snapshots are easily
+ distinguished from released versions. The point version is reset to zero
+ when the minor changes.
+
+ Stable branches work a little differently, since there should be little to
+ no development happening in such branches. Remember, only bugfixes, which
+ presumably should have had some testing before being committed. Stable
+ branches will then have their version reported as 0.0.0, during that period
+ between releases when changes are being added. This is to denote that this
+ code is not for release. Then as the release nears, the version is bumped
+ according: e.g. 3.0.1 -> 0.0.0 -> 3.0.2.
+
+In summary, the main CVS trunk is the development branch where new features are
+being worked on for the next stable series. This should almost always be where
+the most activity takes place. There is always at least one stable branch from
+the trunk, e.g now it is 3.0, which is only used to release stable versions.
+Once the initial *.0 release of the stable branch has been done, then as a
+rule, only bugfixes that have had prior testing should be committed to the
+stable branch. Once there are enough bugfixes to justify a new release, the
+version of this branch is again incremented Example: 3.0.0 -> 3.0.1 -> 3.0.2,
+etc are all stable releases from within the stable branch. 3.1.x is currently
+the main trunk, and where work on 3.2.x is taking place. If any questions,
+please post to the devel list before committing to a stable branch!
-Replace X, Y and Z with the actual version number (X = major, Y = minor, Z =
-point):
+Developers should remember too that if they commit a bugfix to the stable
+branch, this will more than likely require a separate submission to the main
+trunk, since these are separate development trees within CVS. If you are
+working on both, then this would require at least two separate check outs (i.e
+main trunk, and the stable release branch, which is v_3_0_branch at the
+moment).
-------------------------------------------------------------------------------
-8.1. Before the Release
+6.2. Before the Release: Freeze
The following must be done by one of the developers prior to each new release.
* Make sure that everybody who has worked on the code in the last couple of
days has had a chance to yell "no!" in case they have pending changes/fixes
- in their pipelines.
+ in their pipelines. Announce the freeze so that nobody will interfere with
+ last minute changes.
- * Increment the version number in configure.in in CVS. Also, increase or
- reset the RPM release number in configure.in as appropriate. Do NOT touch
- version information after export from CVS. All packages will use the
- version and release data from configure.in. Local files should not be
- changed, except prior to a CVS commit!!! This way we are all on the same
- page!
+ * Increment the version number (point from odd to even in development
+ branches!) in configure.in. (RPM spec files will need to be incremented as
+ well.)
- * If the default actionsfile has changed since last release, bump up its
- version info in this line:
+ * If default.action has changed since last release (i.e. software release or
+ standalone actions file release), bump up its version info to A.B in this
+ line:
{+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
-
Then change the version info in doc/webserver/actions/index.php, line:
'$required_actions_file_version = "A.B";'
+ * All documentation should be rebuild after the version bump. Finished docs
+ should be then be committed to CVS (for those without the ability to build
+ these). Some docs may require rather obscure processing tools. config, the
+ man page (and the html version of the man page), and the PDF docs fall in
+ this category. REAMDE, the man page, AUTHORS, and config should all also be
+ committed to CVS for other packagers. The formal docs should be uploaded to
+ the webserver. See the Section "Updating the webserver" in this manual for
+ details.
+
+ * The User Manual is also used for context sensitive help for the CGI editor.
+ This is version sensitive, so that the user will get appropriate help for
+ his/her release. So with each release a fresh version should be uploaded to
+ the webserver (this is in addition to the main User Manual link from the
+ main page since we need to keep manuals for various versions available).
+ The CGI pages will link to something like http://privoxy.org/$(VERSION)/
+ user-manual/. This will need to be updated for each new release. There is
+ no Makefile target for this at this time!!! It needs to be done manually.
+
+ * All developers should look at the ChangeLog and make sure noteworthy
+ changes are referenced.
+
* Commit all files that were changed in the above steps!
* Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
- * The first package uploaded should be the official "tarball" release, as
- required by the GPL. This is built with the "make tarball-dist" Makefile
- target, and then can be uploaded with "make tarball-upload" (see below).
+ * If the release was in a development branch, increase the point version from
+ even to odd (X.Y.(Z+1)) again in configure.in and commit your change.
+
+ * On the webserver, copy the user manual to a new top-level directory called
+ X.Y.Z. This ensures that help links from the CGI pages, which have the
+ version as a prefix, will go into the right version of the manual. If this
+ is a development branch release, also symlink X.Y.(Z-1) to X.Y.Z and X.Y.
+ (Z+1) to . (i.e. dot).
-------------------------------------------------------------------------------
-8.2. Update the webserver
+6.3. Building and Releasing the Packages
-All files must be group-readable and group-writable (or no one else will be
-able to change them)! To update the webserver, create any pages locally in the
-doc/webserver/* directory (or create new directories under doc/webserver), then
-do
+Now the individual packages can be built and released. Note that for GPL
+reasons the first package to be released is always the source tarball.
- make webserver
-
+For all types of packages, including the source tarball, you must make sure
+that you build from clean sources by exporting the right version from CVS into
+an empty directory (just press return when asked for a password):
-This will do the upload to the webserver (www.privoxy.org).
+ mkdir dist # delete or choose different name if it already exists
+ cd dist
+ cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
+ cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
-Note that "make dok" (or "make redhat-dok") creates doc/webserver/user-manual,
-doc/webserver/developer-manual, doc/webserver/faq and doc/webserver/index.html
-automatically. (doc/webserver/man-page/privoxy-man-page.html is created by a
-separate Makefile target, "make man", due to dependencies on some obscure perl
-scripts. See comments in GNUmakefile.)
+Do NOT change a single bit, including, but not limited to version information
+after export from CVS. This is to make sure that all release packages, and with
+them, all future bug reports, are based on exactly the same code.
-Someone should also commit these to CVS so that packagers without the ability
-to build docs locally, have access to them. This is a separate step, and should
-also be done before each official release.
++-----------------------------------------------------------------------------+
+| Warning |
+|-----------------------------------------------------------------------------|
+|Every significant release of Privoxy has included at least one package that |
+|either had incorrect versions of files, missing files, or incidental |
+|leftovers from a previous build process that gave unknown numbers of users |
+|headaches to try to figure out what was wrong. PLEASE, make sure you are |
+|using pristene sources, and are following the prescribed process! |
++-----------------------------------------------------------------------------+
-Please do NOT use any other means of transferring files to the webserver. "make
-webserver" not only uploads, but will make sure that the appropriate
-permissions are preserved for shared group access.
+Please find additional instructions for the source tarball and the individual
+platform dependent binary packages below. And details on the Sourceforge
+release process below that.
-------------------------------------------------------------------------------
-8.3. SuSE or Red Hat
+6.3.1. Note on Privoxy Packaging
+
+Please keep these general guidelines in mind when putting together your
+package. These apply to all platforms!
-Ensure that you have the latest code version. Hence run:
+ * Privoxy requires write access to: all *.action files, all logfiles, and the
+ trust file. You will need to determine the best way to do this for your
+ platform.
+
+ * Please include up to date documentation. At a bare minimum:
+
+ LICENSE (top-level directory)
+
+ README (top-level directory)
+
+ AUTHORS (top-level directory)
+
+ man page (top-level directory, Unix-like platforms only)
+
+ The User Manual (doc/webserver/user-manual/)
+
+ FAQ (doc/webserver/faq/)
+
+ Also suggested: Developer Manual (doc/webserver/developer-manual) and
+ ChangeLog (top-level directory). FAQ and the manuals are HTML docs. There
+ are also text versions in doc/text/ which could conceivably also be
+ included.
+
+ The documentation has been designed such that the manuals are linked to
+ each other from parallel directories, and should be packaged that way.
+ privoxy-index.html can also be included and can serve as a focal point for
+ docs and other links of interest (and possibly renamed to index.html). This
+ should be one level up from the manuals. There is a link also on this page
+ to an HTMLized version of the man page. To avoid 404 for this, it is in CVS
+ as doc/webserver/man-page/privoxy-man-page.html, and should be included
+ along with the manuals. There is also a css stylesheets that can be
+ included for better presentation: p_doc.css. This should be in the same
+ directory with privoxy-index.html, (i.e. one level up from the manual
+ directories).
+
+ * user.action and user.filter are designed for local preferences. Make sure
+ these do not get overwritten! config should not be overwritten either. This
+ has especially important configuration data in it. trust should be left in
+ tact as well.
+
+ * Other configuration files (default.action, default.filter and
+ standard.action) should be installed as the new defaults, but all
+ previously installed configuration files should be preserved as backups.
+ This is just good manners :-) These files are likely to change between
+ releases and contain important new features and bug fixes.
+
+ * Please check platform specific notes in this doc, if you haven't done
+ "Privoxy" packaging before for other platform specific issues. Conversely,
+ please add any notes that you know are important for your platform (or
+ contact one of the doc maintainers to do this if you can't).
+
+ * Packagers should do a "clean" install of their package after building it.
+ So any previous installs should be removed first to ensure the integrity of
+ the newly built package. Then run the package for a while to make sure
+ there are no obvious problems, before uploading.
+
+-------------------------------------------------------------------------------
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd current
-
+6.3.2. Source Tarball
-first.
+First, make sure that you have freshly exported the right version into an empty
+directory. (See "Building and releasing packages" above). Then run:
+ cd current
+ autoheader && autoconf && ./configure
+
+Then do:
+
+ make tarball-dist
+
+To upload the package to Sourceforge, simply issue
+
+ make tarball-upload
+
+Go to the displayed URL and release the file publicly on Sourceforge. For the
+change log field, use the relevant section of the ChangeLog file.
+
+-------------------------------------------------------------------------------
+
+6.3.3. SuSE, Conectiva or Red Hat RPM
+
+In following text, replace dist with either "rh" for Red Hat or "suse" for
+SuSE.
+
+First, make sure that you have freshly exported the right version into an empty
+directory. (See "Building and releasing packages" above).
+
+As the only exception to not changing anything after export from CVS, now
+examine the file privoxy-dist.spec and make sure that the version information
+and the RPM release number are correct. The RPM release numbers for each
+version start at one. Hence it must be reset to one if this is the first RPM
+for dist which is built from version X.Y.Z. Check the file list if unsure.
+Else, it must be set to the highest already available RPM release number for
+that version plus one.
+
+Then run:
+
+ cd current
autoheader && autoconf && ./configure
-
Then do
- make suse-dist or make redhat-dist
-
+ make dist-dist
To upload the package to Sourceforge, simply issue
- make suse-upload (or make redhat-upload)
-
+ make dist-upload rpm_packagerev
-Go to the displayed URL and release the file publicly on Sourceforge.
+where rpm_packagerev is the RPM release number as determined above. Go to the
+displayed URL and release the file publicly on Sourceforge. Use the release
+notes and change log from the source tarball package.
-------------------------------------------------------------------------------
-8.4. OS/2
+6.3.4. OS/2
-Ensure that you have the latest code version. Hence run:
+First, make sure that you have freshly exported the right version into an empty
+directory. (See "Building and releasing packages" above). Then get the OS/2
+Setup module:
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd ..
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
-
+ cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
You will need a mix of development tools. The main compilation takes place with
IBM Visual Age C++. Some ancillary work takes place with GNU tools, available
the final executable filename. For example,
installExeName='privoxyos2_setup_X.Y.Z.exe'
-
Next, edit the IJB.wis file so the release number matches in the PACKAGEID
section:
PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
-
You're now ready to build. Run:
os2build
-
-And in the ./files directory you will have the WarpIN-installable executable.
+You will find the WarpIN-installable executable in the ./files directory.
Upload this anonymously to uploads.sourceforge.net/incoming, create a release
-for it, and you're done.
+for it, and you're done. Use the release notes and Change Log from the source
+tarball package.
-------------------------------------------------------------------------------
-8.5. Solaris
+6.3.5. Solaris
-Login to Sourceforge's compilefarm via ssh
+Login to Sourceforge's compilefarm via ssh:
ssh cf.sourceforge.net
-
-Choose the right operating system (not the Debian one). If you have downloaded
-Privoxy before,
-
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd current
-
-
-If not, please checkout Privoxy via CVS first. Run:
+Choose the right operating system (not the Debian one). When logged in, make
+sure that you have freshly exported the right version into an empty directory.
+(See "Building and releasing packages" above). Then run:
+ cd current
autoheader && autoconf && ./configure
-
Then run
gmake solaris-dist
-
which creates a gzip'ed tar archive. Sadly, you cannot use make solaris-upload
on the Sourceforge machine (no ncftpput). You now have to manually upload the
-archive to Sourceforge's ftp server and release the file publicly.
+archive to Sourceforge's ftp server and release the file publicly. Use the
+release notes and Change Log from the source tarball package.
-------------------------------------------------------------------------------
-8.6. Windows
+6.3.6. Windows
You should ensure you have the latest version of Cygwin (from http://
www.cygwin.com/). Run the following commands from within a Cygwin bash shell.
-First check out a clean copy of the correct code version, by running:
-
- mkdir dist
- cd dist
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z .
-
+First, make sure that you have freshly exported the right version into an empty
+directory. (See "Building and releasing packages" above). Then get the Windows
+setup module:
-(Note: It is important that this is a clean copy of the code, do not re-use a
-working directory after you have manually compiled there).
+ cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
Then you can build the package. This is fully automated, and is controlled by
winsetup/GNUmakefile. All you need to do is:
- cd winsetup
- make
-
+ cd winsetup
+ make
Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
-upload it to SourceForge.
+upload it to SourceForge. When releasing the package on SourceForge, use the
+release notes and Change Log from the source tarball package.
-------------------------------------------------------------------------------
-8.7. Debian
+6.3.7. Debian
-Ensure that you have the latest code version. Hence run:
+First, make sure that you have freshly exported the right version into an empty
+directory. (See "Building and releasing packages" above). Then add a log entry
+to debian/changelog, if it is not already there, for example by running:
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd current
-
+ debchange -v 3.0.5-BETA-1 "New upstream version"
-first. Run:
+Then, run:
- autoheader && autoconf && ./configure
-
+ dpkg-buildpackage -rfakeroot -us -uc -b
-Then do FIXME.
+This will create ../privoxy_3.0.5-BETA-1_i386.deb which can be uploaded. To
+upload the package to Sourceforge, simply issue
+
+ make debian-upload
-------------------------------------------------------------------------------
-8.8. Mac OSX
+6.3.8. Mac OSX
-Ensure that you have the latest code version. Hence run:
+First, make sure that you have freshly exported the right version into an empty
+directory. (See "Building and releasing packages" above). Then get the Mac OSX
+setup module:
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd ..
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
-
+ cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
-From the osxsetup directory, run:
+Then run:
+ cd osxsetup
build
-
This will run autoheader, autoconf and configure as well as make. Finally, it
will copy over the necessary files to the ./osxsetup/files directory for
specify ./Privoxy.pkg as the output package name, you can then create the
distributable zip file with the command:
-zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
-
+ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
You can then upload privoxyosx_setup_x.y.z.zip anonymously to
-uploads.sourceforge.net/incoming, create a release for it, and you're done.
+uploads.sourceforge.net/incoming, create a release for it, and you're done. Use
+the release notes and Change Log from the source tarball package.
-------------------------------------------------------------------------------
-8.9. FreeBSD
-
-Change the version number of Privoxy in the configure.in file. Run:
-
- autoheader && autoconf && ./configure
-
-
-Then ...
+6.3.9. FreeBSD
-Login to Sourceforge's compilefarm via ssh:
+Login to Sourceforge's compile-farm via ssh:
ssh cf.sourceforge.net
-
-Choose the right operating system.
-
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd current
-
-
-Run:
+Choose the right operating system. When logged in, make sure that you have
+freshly exported the right version into an empty directory. (See "Building and
+releasing packages" above). Then run:
+ cd current
autoheader && autoconf && ./configure
-
Then run:
gmake freebsd-dist
-
which creates a gzip'ed tar archive. Sadly, you cannot use make freebsd-upload
on the Sourceforge machine (no ncftpput). You now have to manually upload the
-archive to Sourceforge's ftp server and release the file publicly.
+archive to Sourceforge's ftp server and release the file publicly. Use the
+release notes and Change Log from the source tarball package.
-------------------------------------------------------------------------------
-8.10. Tarball
+6.3.10. HP-UX 11
+
+First, make sure that you have freshly exported the right version into an empty
+directory. (See "Building and releasing packages" above). Then run:
+
+ cd current
+ autoheader && autoconf && ./configure
-Ensure that you have the right code version. Hence run:
+Then do FIXME.
+
+-------------------------------------------------------------------------------
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd current
-
+6.3.11. Amiga OS
-first. Run:
+First, make sure that you have freshly exported the right version into an empty
+directory. (See "Building and releasing packages" above). Then run:
+ cd current
autoheader && autoconf && ./configure
-
-Then do:
+Then do FIXME.
- make tarball-dist
-
+-------------------------------------------------------------------------------
-To upload the package to Sourceforge, simply issue
+6.3.12. AIX
- make tarball-upload
-
+Login to Sourceforge's compilefarm via ssh:
+
+ ssh cf.sourceforge.net
+
+Choose the right operating system. When logged in, make sure that you have
+freshly exported the right version into an empty directory. (See "Building and
+releasing packages" above). Then run:
+
+ cd current
+ autoheader && autoconf && ./configure
+
+Then run:
-Goto the displayed URL and release the file publicly on Sourceforge.
+ make aix-dist
+
+which creates a gzip'ed tar archive. Sadly, you cannot use make aix-upload on
+the Sourceforge machine (no ncftpput). You now have to manually upload the
+archive to Sourceforge's ftp server and release the file publicly. Use the
+release notes and Change Log from the source tarball package.
-------------------------------------------------------------------------------
-8.11. HP-UX 11
+6.4. Uploading and Releasing Your Package
-Ensure that you have the latest code version. Hence run:
+After the package is ready, it is time to upload it to SourceForge, and go
+through the release steps. The upload is done via FTP:
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd current
-
+ * Upload to: ftp://upload.sourceforge.net/incoming
+
+ * user: anonymous
+
+ * password: ijbswa-developers@lists.sourceforge.net
+
+Or use the make targets as described above.
-first. Run:
+Once this done go to http://sourceforge.net/project/admin/editpackages.php?
+group_id=11118, making sure you are logged in. Find your target platform in the
+second column, and click Add Release. You will then need to create a new
+release for your package, using the format of $VERSION ($CODE_STATUS), e.g.
+3.0.5 (beta).
- autoheader && autoconf && ./configure
-
+Now just follow the prompts. Be sure to add any appropriate Release notes. You
+should see your freshly uploaded packages in "Step 2. Add Files To This
+Release". Check the appropriate box(es). Remember at each step to hit the
+"Refresh/Submit" buttons! You should now see your file(s) listed in Step 3.
+Fill out the forms with the appropriate information for your platform, being
+sure to hit "Update" for each file. If anyone is monitoring your platform,
+check the "email" box at the very bottom to notify them of the new package.
+This should do it!
-Then do FIXME.
+If you have made errors, or need to make changes, you can go through
+essentially the same steps, but select Edit Release, instead of Add Release.
-------------------------------------------------------------------------------
-8.12. Amiga OS
+6.5. After the Release
-Ensure that you have the latest code version. Hence run:
+When all (or: most of the) packages have been uploaded and made available, send
+an email to the announce mailing list, Subject: "Version X.Y.Z available for
+download". Be sure to include the download location, the release notes and the
+Changelog. Also, post an updated News item on the project page Sourceforge, and
+update the Home page and docs linked from the Home page (see below). Other news
+sites and release oriented sites, such as Freshmeat, should also be notified.
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd current
-
+-------------------------------------------------------------------------------
-first. Run:
+7. Update the Webserver
- autoheader && autoconf && ./configure
-
+The webserver should be updated at least with each stable release. When
+updating, please follow these steps to make sure that no broken links,
+inconsistent contents or permission problems will occur (as it has many times
+in the past!):
-Then do FIXME.
+If you have changed anything in the stable-branch documentation source SGML
+files, do:
+
+ make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
+
+That will generate doc/webserver/user-manual, doc/webserver/developer-manual,
+doc/webserver/faq, doc/pdf/*.pdf and doc/webserver/index.html automatically.
+
+If you changed the manual page sources, generate doc/webserver/man-page/
+privoxy-man-page.html by running "make man". (This is a separate target due to
+dependencies on some obscure perl scripts [now in CVS, but not well tested].
+See comments in GNUmakefile.)
+
+If you want to add new files to the webserver, create them locally in the doc/
+webserver/* directory (or create new directories under doc/webserver).
+
+Next, commit any changes from the above steps to CVS. All set? If these are
+docs in the stable branch, then do:
+
+ make webserver
+
+This will do the upload to the webserver (www.privoxy.org) and ensure all files
+and directories there are group writable.
+
+Please do NOT use any other means of transferring files to the webserver to
+avoid permission problems. Also, please do not upload docs from development
+branches or versions. The publicly posted docs should be in sync with the last
+official release.
-------------------------------------------------------------------------------
-8.13. AIX
+8. Contacting the developers, Bug Reporting and Feature Requests
-Login to Sourceforge's compilefarm via ssh:
+We value your feedback. In fact, we rely on it to improve Privoxy and its
+configuration. However, please note the following hints, so we can provide you
+with the best support:
- ssh cf.sourceforge.net
-
+-------------------------------------------------------------------------------
-Choose the right operating system. If you have downloaded Privoxy before:
+8.1. Get Support
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
- cd current
-
+For casual users, our support forum at SourceForge is probably best suited:
+http://sourceforge.net/tracker/?group_id=11118&atid=211118
-If not, please checkout Privoxy via CVS first. Run:
+All users are of course welcome to discuss their issues on the users mailing
+list, where the developers also hang around.
- autoheader && autoconf && ./configure
-
+-------------------------------------------------------------------------------
-Then run:
+8.2. Reporting Problems
- make aix-dist
-
+"Problems" for our purposes, come in two forms:
-which creates a gzip'ed tar archive. Sadly, you cannot use make aix-upload on
-the Sourceforge machine (no ncftpput). You now have to manually upload the
-archive to Sourceforge's ftp server and release the file publicly.
+ * Configuration issues, such as ads that slip through, or sites that don't
+ function properly due to one Privoxy "action" or another being turned "on".
+
+ * "Bugs" in the programming code that makes up Privoxy, such as that might
+ cause a crash.
+
+-------------------------------------------------------------------------------
+
+8.2.1. Reporting Ads or Other Configuration Problems
+
+Please send feedback on ads that slipped through, innocent images that were
+blocked, sites that don't work properly, and other configuration related
+problem of default.action file, to http://sourceforge.net/tracker/?group_id=
+11118&atid=460288, the Actions File Tracker.
+
+New, improved default.action files may occasionally be made available based on
+your feedback. These will be announced on the ijbswa-announce list and
+available from our the files section of our project page.
-------------------------------------------------------------------------------
-9. Contacting the developers, Bug Reporting and Feature Requests
+8.2.2. Reporting Bugs
-We value your feedback. However, to provide you with the best support, please
-note:
+Please report all bugs only through our bug tracker: http://sourceforge.net/
+tracker/?group_id=11118&atid=111118.
- * Use the Sourceforge Support Forum to get help:
-
- http://sourceforge.net/tracker/?group_id=11118&atid=211118
-
+Before doing so, please make sure that the bug has not already been submitted
+and observe the additional hints at the top of the submit form. If already
+submitted, please feel free to add any info to the original report that might
+help to solve the issue.
+
+Please try to verify that it is a Privoxy bug, and not a browser or site bug
+first. If unsure, try toggling off Privoxy, and see if the problem persists. If
+you are using your own custom configuration, please try the stock configs to
+see if the problem is configuration related.
+
+If not using the latest version, the bug may have been found and fixed in the
+meantime. We would appreciate if you could take the time to upgrade to the
+latest version (or even the latest CVS snapshot) and verify your bug.
+
+Please be sure to provide the following information:
+
+ * The exact Privoxy version of the proxy software (if you got the source from
+ CVS, please also provide the source code revisions as shown in http://
+ config.privoxy.org/show-version).
- * Submit bugs only through our Sourceforge Bug Forum:
-
- http://sourceforge.net/tracker/?group_id=11118&atid=111118.
-
-
- Make sure that the bug has not already been submitted. Please try to verify
- that it is a Privoxy bug, and not a browser or site bug first. If you are
- using your own custom configuration, please try the stock configs to see if
- the problem is a configuration related bug. And if not using the latest
- development snapshot, please try the latest one. Or even better, CVS
- sources. Please be sure to include the Privoxy/Junkbuster version,
- platform, browser, any pertinent log data, any other relevant details
- (please be specific) and, if possible, some way to reproduce the bug.
-
- * Submit feature requests only through our Sourceforge feature request forum:
-
- http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
-
+ * The operating system and versions you run Privoxy on, (e.g. Windows XP
+ SP2), if you are using some kind of Unix flavour, sending the output of
+ "uname -a" should do.
- * You can also send feedback on websites that Privoxy has problems with. Please bookmark
- the following link: "Privoxy - Submit Filter Feedback"
- . Once you surf to a page with problems, use the
- bookmark to send us feedback. We will look into the issue as soon as possible.
-
+ * The name, platform, and version of the browser you were using (e.g.
+ Internet Explorer v5.5 for Mac).
+
+ * The URL where the problem occurred, or some way for us to duplicate the
+ problem (e.g. http://somesite.example.com/?somethingelse=123).
+
+ * Whether your version of Privoxy is one supplied by the developers of
+ Privoxy via SourceForge, or somewhere else.
+
+ * Whether you are using Privoxy in tandem with another proxy such as Tor. If
+ so, please try disabling the other proxy.
- * For any other issues, feel free to use the mailing lists:
-
- http://sourceforge.net/mail/?group_id=11118.
-
+ * Whether you are using a personal firewall product. If so, does Privoxy work
+ without it?
- Anyone interested in actively participating in development and related
- discussions can also join the appropriate mailing list. Archives are
- available, too.
+ * Any other pertinent information to help identify the problem such as config
+ or log file excerpts (yes, you should have log file entries for each action
+ taken).
+ * Please provide your SF login, or email address, in case we need to contact
+ you.
+
+The appendix of the Privoxy User Manual also has helpful information on
+understanding actions, and action debugging.
+
-------------------------------------------------------------------------------
-10. Copyright and History
+8.3. Request New Features
-10.1. Copyright
+You are welcome to submit ideas on new features or other proposals for
+improvement through our feature request tracker at http://sourceforge.net/
+tracker/?atid=361118&group_id=11118.
+
+-------------------------------------------------------------------------------
+
+8.4. Other
+
+For any other issues, feel free to use the mailing lists. Technically
+interested users and people who wish to contribute to the project are also
+welcome on the developers list! You can find an overview of all Privoxy-related
+mailing lists, including list archives, at: http://sourceforge.net/mail/?
+group_id=11118.
+
+-------------------------------------------------------------------------------
+
+9. Privoxy Copyright, License and History
+
+Copyright © 2001 - 2006 by Privoxy Developers <
+ijbswa-developers@lists.sourceforge.net>
+
+Some source code is based on code Copyright © 1997 by Anonymous Coders and
+Junkbusters, Inc. and licensed under the GNU General Public License.
+
+-------------------------------------------------------------------------------
+
+9.1. License
Privoxy is free software; you can redistribute it and/or modify it under the
-terms of the GNU General Public License as published by the Free Software
-Foundation; either version 2 of the License, or (at your option) any later
-version.
+terms of the GNU General Public License, version 2, as published by the Free
+Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details, which
-is available from the Free Software Foundation, Inc, 59 Temple Place - Suite
-330, Boston, MA 02111-1307, USA.
+is available from the Free Software Foundation, Inc, 51 Franklin Street, Fifth
+Floor, Boston, MA 02110-1301, USA
You should have received a copy of the GNU General Public License along with
-this program; if not, write to the Free Software Foundation, Inc., 59 Temple
-Place, Suite 330, Boston, MA 02111-1307 USA.
+this program; if not, write to the
+
+ Free Software
+ Foundation, Inc. 51 Franklin Street, Fifth Floor
+ Boston, MA 02110-1301
+ USA
-------------------------------------------------------------------------------
-10.2. History
+9.2. History
+
+Along time ago, there was the Internet Junkbuster, by Anonymous Coders and
+Junkbusters Corporation. This saved many users a lot of pain in the early days
+of web advertising and user tracking.
+
+But the web, its protocols and standards, and with it, the techniques for
+forcing ads on users, give up autonomy over their browsing, and for tracking
+them, keeps evolving. Unfortunately, the Internet Junkbuster did not. Version
+2.0.2, published in 1998, was (and is) the last official release available from
+Junkbusters Corporation. Fortunately, it had been released under the GNU GPL,
+which allowed further development by others.
-Privoxy is evolved, and derived from, the Internet Junkbuster, with many
-improvments and enhancements over the original.
+So Stefan Waldherr started maintaining an improved version of the software, to
+which eventually a number of people contributed patches. It could already
+replace banners with a transparent image, and had a first version of pop-up
+killing, but it was still very closely based on the original, with all its
+limitations, such as the lack of HTTP/1.1 support, flexible per-site
+configuration, or content modification. The last release from this effort was
+version 2.0.2-10, published in 2000.
-Junkbuster was originally written by Anonymous Coders and Junkbusters
-Corporation, and was released as free open-source software under the GNU GPL.
-Stefan Waldherr made many improvements, and started the SourceForge project
-Privoxy to rekindle development. There are now several active developers
-contributing. The last stable release of Junkbuster was v2.0.2, which has now
-grown whiskers ;-).
+Then, some developers picked up the thread, and started turning the software
+inside out, upside down, and then reassembled it, adding many new features
+along the way.
+
+The result of this is Privoxy, whose first stable version, 3.0, was released
+August, 2002.
-------------------------------------------------------------------------------
-11. See also
+10. See also
Other references and sites of interest to Privoxy users:
-http://www.privoxy.org/, The Privoxy Home page.
+http://www.privoxy.org/, the Privoxy Home page.
+
+http://www.privoxy.org/faq/, the Privoxy FAQ.
+
+http://sourceforge.net/projects/ijbswa/, the Project Page for Privoxy on
+SourceForge.
-http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on
-Sourceforge.
+http://config.privoxy.org/, the web-based user interface. Privoxy must be
+running for this to work. Shortcut: http://p.p/
-http://p.p/, access Privoxy from your browser. Alternately, http://
-config.privoxy.org may work in some situations where the first does not.
+http://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit "misses"
+and other configuration related suggestions to the developers.
-http://p.p/, and select "actions file feedback system" to submit "misses" to
-the developers.
+http://www.junkbusters.com/ht/en/cookies.html, an explanation how cookies are
+used to track web users.
-http://www.junkbusters.com/ht/en/cookies.html
+http://www.junkbusters.com/ijb.html, the original Internet Junkbuster.
-http://www.waldherr.org/junkbuster/
+http://privacy.net/, a useful site to check what information about you is
+leaked while you browse the web.
-http://privacy.net/analyze/
+http://www.squid-cache.org/, a very popular caching proxy, which is often used
+together with Privoxy.
-http://www.squid-cache.org/
+http://tor.eff.org/, Tor can help anonymize web browsing, web publishing,
+instant messaging, IRC, SSH, and other applications.
-
+http://www.privoxy.org/developer-manual/, the Privoxy developer manual.
projects / privoxy.git / blobdiff