By: Privoxy Developers
-$Id: developer-manual.sgml,v 1.18 2002/04/03 03:51:48 hal9 Exp $
+$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 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.
tastes. Privoxy has application for both stand-alone systems and multi-user
networks.
-Privoxy is based on the code of the Internet Junkbuster. Junkbuster was
-originally written by JunkBusters Corporation, and was released as free
+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 and
-enhancements.
+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 of the User Manual on how to
-contact the developers.
+developer-manual/. Please see the Contact section on how to contact the
+developers.
-------------------------------------------------------------------------------
Table of Contents
+
1. Introduction
-2. Quickstart to Privoxy Development
-3. Documentation Guidelines
-4. Coding Guidelines
+3. Quickstart to Privoxy Development
+4. Documentation Guidelines
- 4.1. Introduction
- 4.2. Using Comments
+ 4.1. Quickstart to Docbook and SGML
+ 4.2. Privoxy Documentation Style
+ 4.3. Privoxy Custom Entities
+
+5. Coding Guidelines
+
+ 5.1. Introduction
+ 5.2. Using Comments
- 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
+ 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
screen length
- 4.3. Naming Conventions
+ 5.3. Naming Conventions
- 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.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.4. Using Space
+ 5.4. Using Space
- 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.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.5. Initializing
+ 5.5. Initializing
- 4.5.1. Initialize all variables
+ 5.5.1. Initialize all variables
- 4.6. Functions
+ 5.6. Functions
- 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
+ 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
Includes
- 4.7. General Coding Practices
+ 5.7. General Coding Practices
- 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
+ 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
'free'
- 4.7.9. Add loaders to the `file_list' structure and in order
- 4.7.10. "Uncertain" new code and/or changes to exitinst code, use FIXME
+ 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.8. Addendum: Template for files and function comment blocks:
+ 5.8. Addendum: Template for files and function comment blocks:
+
+6. Version Control Guidelines
+7. Testing Guidelines
-5. Version Control Guidelines
-6. Testing Guidelines
+ 7.1. Testplan for releases
+ 7.2. Test reports
- 6.1. Testplan for releases
- 6.2. Test reports
+8. Releasing a new version
-7. 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
- 7.1. Before the Release
- 7.2. Update the webserver
- 7.3. SuSE or Red Hat
- 7.4. OS/2
- 7.5. Solaris
- 7.6. Windows
- 7.7. Debian
- 7.8. Mac OSX
- 7.9. FreeBSD
- 7.10. Tarball
- 7.11. HP-UX 11
- 7.12. Amiga OS
- 7.13. AIX
+9. Contacting the developers, Bug Reporting and Feature Requests
+10. Copyright and History
-8. Contact the developers
-9. Copyright and History
-10. See also
+ 10.1. Copyright
+ 10.2. History
+
+11. See also
+
+-------------------------------------------------------------------------------
1. Introduction
-------------------------------------------------------------------------------
-2. Quickstart to Privoxy Development
+3. Quickstart to Privoxy Development
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.
5. A major redesign of some part of the code: ask the list
+Note that near a major public release, we get a bit more cautious - if unsure,
+it doesn't hurt to ask first.
+
-------------------------------------------------------------------------------
-3. Documentation Guidelines
+4. Documentation Guidelines
-All formal documents are maintained in docbook SGML and located in the doc/
-source directory. You will need docbook and the docbook stylesheets (or
-comparable alternatives), and either jade or openjade installed in order to
-build docs from source. Currently there is user-manual, FAQ, and, of course
-this, the developer-manual in this format.
+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. README, LICENSE) are maintained as plain
-text files in the toplevel source directory.
+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.
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. Or
-HTML versions can be downloaded from the www.privoxy.org website, which should
-be fairly current.
+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/*.
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
-uses the document SGML sources in doc/source to update all text files in doc/
-text and to update all HTML documents in doc/webserver.
+uses the document SGML sources in doc/source/*/* to update all text files in
+doc/text/ and to update all HTML documents in doc/webserver/.
Documentation writers should please make sure documents build successfully
-before committing to CVS.
+before committing to CVS, if possible.
How do you update the webserver (i.e. the pages on privoxy.org)?
2. Run make webserver which copies all files from doc/webserver to the
sourceforge webserver via scp.
+Finished docs should be occasionally submitted to CVS (doc/webserver/*/*.html)
+so that those without the ability to build them locally, have access to them if
+needed. This is especially important just prior to a new release! Please do
+this after the $VERSION and other release specific data in configure.in has
+been updated (this is done just prior to a new release).
+
+-------------------------------------------------------------------------------
+
+4.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
+languages. In fact, HTML is an SGML application. Both will use "tags" to format
+text and other content. SGML tags can be much more varied, and flexible, but do
+much of the same kinds of things. The tags, or "elements", are definable in
+SGML. There is no set "standards". Since we are using Docbook, our tags are
+those that are defined by Docbook. Much of how the finish document is rendered
+is determined by the "stylesheets". The stylesheets determine how each tag gets
+translated to HTML, or other formats.
+
+Tags in Docbook SGML need to be always "closed". If not, you will likely
+generate errors. Example: <title>My Title</title>. They are also
+case-insensitive, but we strongly suggest using all lower case. This keeps
+compatibility with [Docbook] XML.
+
+Our documents use "sections" for the most part. Sections will be processed into
+HTML headers (e.g. h1 for sect1). The Docbook stylesheets will use these to
+also generate the Table of Contents for each doc. Our TOC's are set to a depth
+of three. Meaning sect1, sect2, and sect3 will have TOC entries, but sect4 will
+not. Each section requires a <title> element, and at least one <para>. There is
+a limit of five section levels in Docbook, but generally three should be
+sufficient for our purposes.
+
+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.
+
+Look at any of the existing docs for examples of all these and more.
+
+-------------------------------------------------------------------------------
+
+4.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
+fashion.
+
+Here it is:
+
+ * All tags should be lower case.
+
+ * Tags delimiting a block of text (even small blocks) should be on their own
+ line. Like:
+
+ <para>
+ Some text goes here.
+ </para>
+
+
+ Tags marking individual words, or few words, should be in-line:
+
+ Just to <emphasis>emphasize</emphasis>, some text goes here.
+
+
+ * Tags should be nested and step indented for block text like: (except
+ in-line tags)
+
+ <para>
+ <itemizedlist>
+ <para>
+ <listitem>
+ Some text goes here in our list example.
+ </listitem>
+ </para>
+ </itemizedlist>
+ </para>
+
+
+ This makes it easier to find the text amongst the tags ;-)
+
+ * Use white space to separate logical divisions within a document, like
+ between sections. Running everything together consistently makes it harder
+ to read and work on.
+
+ * Do not hesitate to make comments. Comments can either use the <comment>
+ element, or the <!-- --> style comment familiar from HTML. (Note in Docbook
+ v4.x <comment> is replaced by <remark>.)
+
+ * We have an international audience. Refrain from slang, or English
+ idiosyncrasies (too many to list :). Humor also does not translate well
+ sometimes.
+
+ * Try to keep overall line lengths in source files to 80 characters or less
+ for obvious reasons. This is not always possible, with lengthy URLs for
+ 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:
+
+ My favorite site is <ulink url="http://example.com">here</ulink>.
+
+ This will render as "My favorite site is here", which is not real helpful
+ in a text doc. Better like this:
+
+ My favorite site is <ulink url="http://example.com">example.com</ulink>.
+
+ * All documents should be spell checked occasionally. aspell can check SGML
+ with the -H option. (ispell I think too.)
+
+-------------------------------------------------------------------------------
+
+4.3. Privoxy Custom Entities
+
+Privoxy documentation is using a number of customized "entities" to facilitate
+documentation maintenance.
+
+We are using a set of "boilerplate" files with generic text, that is used by
+multiple docs. This way we can write something once, and use it repeatedly
+without having to re-write the same content over and over again. If editing
+such a file, keep in mind that it should be generic. That is the purpose; so it
+can be used in varying contexts without additional modifications.
+
+We are also using what Docbook calls "internal entities". These are like
+variables in programming. Well, sort of. For instance, we have the p-version
+entity that contains the current Privoxy version string. You are strongly
+encouraged to use these where possible. Some of these obviously require
+re-setting with each release (done by the Makefile). A sampling of custom
+entities are listed below. See any of the main docs for examples.
+
+ * Re- "boilerplate" text entities are defined like:
+
+ <!entity supported SYSTEM "supported.sgml">
+
+ In this example, the contents of the file, supported.sgml is available for
+ inclusion anywhere in the doc. To make this happen, just reference the now
+ defined entity: &supported; (starts with an ampersand and ends with a
+ semi-colon), and the contents will be dumped into the finished doc at that
+ point.
+
+ * Commonly used "internal entities":
+
+ p-version: the Privoxy version string, e.g. "2.9.14".
+ 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").
+ p-stable: just the opposite.
+ p-text: this doc is only generated as text.
+
+There are others in various places that are defined for a specific purpose.
+Read the source!
+
-------------------------------------------------------------------------------
-4. Coding Guidelines
+5. Coding Guidelines
-4.1. Introduction
+5.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"
-------------------------------------------------------------------------------
-4.2. Using Comments
+5.2. Using Comments
-4.2.1. Comment, Comment, Comment
+5.2.1. Comment, Comment, Comment
Explanation:
-------------------------------------------------------------------------------
-4.2.2. Use blocks for comments
+5.2.2. Use blocks for comments
Explanation:
Exception:
-If you are trying to add a small logic comment and do not wish to "disrubt" the
+If you are trying to add a small logic comment and do not wish to "disrupt" the
flow of the code, feel free to use a 1 line comment which is NOT on the same
line as the code.
-------------------------------------------------------------------------------
-4.2.3. Keep Comments on their own line
+5.2.3. Keep Comments on their own line
Explanation:
-------------------------------------------------------------------------------
-4.2.4. Comment each logical step
+5.2.4. Comment each logical step
Explanation:
-------------------------------------------------------------------------------
-4.2.5. Comment All Functions Thoroughly
+5.2.5. Comment All Functions Thoroughly
Explanation:
-------------------------------------------------------------------------------
-4.2.6. Comment at the end of braces if the content is more than one screen
+5.2.6. Comment at the end of braces if the content is more than one screen
length
Explanation:
-------------------------------------------------------------------------------
-4.3. Naming Conventions
+5.3. Naming Conventions
-4.3.1. Variable Names
+5.3.1. Variable Names
Explanation:
-Use all lowercase, and seperate words via an underscore ('_'). Do not start an
+Use all lowercase, and separate words via an underscore ('_'). Do not start an
identifier with an underscore. (ANSI C reserves these for use by the compiler
and system headers.) Do not use identifiers which are reserved in ANSI C++.
(E.g. template, class, true, false, ...). This is in case we ever decide to
-------------------------------------------------------------------------------
-4.3.2. Function Names
+5.3.2. Function Names
Explanation:
-Use all lowercase, and seperate words via an underscore ('_'). Do not start an
+Use all lowercase, and separate words via an underscore ('_'). Do not start an
identifier with an underscore. (ANSI C reserves these for use by the compiler
and system headers.) Do not use identifiers which are reserved in ANSI C++.
(E.g. template, class, true, false, ...). This is in case we ever decide to
-------------------------------------------------------------------------------
-4.3.3. Header file prototypes
+5.3.3. Header file prototypes
Explanation:
-------------------------------------------------------------------------------
-4.3.4. Enumerations, and #defines
+5.3.4. Enumerations, and #defines
Explanation:
-------------------------------------------------------------------------------
-4.3.5. Constants
+5.3.5. Constants
Explanation:
-------------------------------------------------------------------------------
-4.4. Using Space
+5.4. Using Space
-4.4.1. Put braces on a line by themselves.
+5.4.1. Put braces on a line by themselves.
Explanation:
if ( this == that ) { ... }
Note: In the special case that the if-statement is inside a loop, and it is
-trivial, i.e. it tests for a condidtion that is obvious from the purpose of the
+trivial, i.e. it tests for a condition that is obvious from the purpose of the
block, one-liners as above may optically preserve the loop structure and make
it easier to read.
-Status: developer-discrection.
+Status: developer-discretion.
Example exception:
-------------------------------------------------------------------------------
-4.4.2. ALL control statements should have a block
+5.4.2. ALL control statements should have a block
Explanation:
-------------------------------------------------------------------------------
-4.4.3. Do not belabor/blow-up boolean expressions
+5.4.3. Do not belabor/blow-up boolean expressions
Example:
if ( condition ) { structure->flag = 1; } else { structure->flag = 0; }
-Note: The former is readable and consice. The later is wordy and inefficient.
+Note: The former is readable and concise. The later is wordy and inefficient.
Please assume that any developer new to the project has at least a "good"
knowledge of C/C++. (Hope I do not offend by that last comment ... 8-)
-------------------------------------------------------------------------------
-4.4.4. Use white space freely because it is free
+5.4.4. Use white space freely because it is free
Explanation:
-------------------------------------------------------------------------------
-4.4.5. Don't use white space around structure operators
+5.4.5. Don't use white space around structure operators
Explanation:
-------------------------------------------------------------------------------
-4.4.6. Make the last brace of a function stand out
+5.4.6. Make the last brace of a function stand out
Example:
int function1( ... ) { ...code... return( retCode ); } int function2( ... ) { }
-Note: Use 1 blank line before the closing brace and 2 lines afterwards. This
+Note: Use 1 blank line before the closing brace and 2 lines afterward. This
makes the end of function standout to the most casual viewer. Although function
-comments help seperate functions, this is still a good coding practice. In
+comments help separate functions, this is still a good coding practice. In
fact, I follow these rules when using blocks in "for", "while", "do" loops, and
long if {} statements too. After all whitespace is free!
-Status: developer-discrection on the number of blank lines. Enforced is the end
+Status: developer-discretion on the number of blank lines. Enforced is the end
of function comments.
-------------------------------------------------------------------------------
-4.4.7. Use 3 character indentions
+5.4.7. Use 3 character indentions
Explanation:
-------------------------------------------------------------------------------
-4.5. Initializing
+5.5. Initializing
-4.5.1. Initialize all variables
+5.5.1. Initialize all variables
Explanation:
to access memory address 00000000 and not 129FA012; or arrayPtr[20] causes a
SIGSEV vs. arrayPtr[0].
-Status: developer-discrection if and only if the variable is assigned a value
+Status: developer-discretion if and only if the variable is assigned a value
"shortly after" declaration.
-------------------------------------------------------------------------------
-4.6. Functions
+5.6. Functions
-4.6.1. Name functions that return a boolean as a question.
+5.6.1. Name functions that return a boolean as a question.
Explanation:
-------------------------------------------------------------------------------
-4.6.2. Always specify a return type for a function.
+5.6.2. Always specify a return type for a function.
Explanation:
-------------------------------------------------------------------------------
-4.6.3. Minimize function calls when iterating by using variables
+5.6.3. Minimize function calls when iterating by using variables
Explanation:
-------------------------------------------------------------------------------
-4.6.4. Pass and Return by Const Reference
+5.6.4. Pass and Return by Const Reference
Explanation:
-------------------------------------------------------------------------------
-4.6.5. Pass and Return by Value
+5.6.5. Pass and Return by Value
Explanation:
-------------------------------------------------------------------------------
-4.6.6. Names of include files
+5.6.6. Names of include files
Explanation:
Example:
-#include <iostream.h> /* This is not a local include */
+#include /* 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 <sys/fileName.h>
+#include
Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
-This duplicates the #include "file.h" behaviour.
+This duplicates the #include "file.h" behavior.
-------------------------------------------------------------------------------
-4.6.7. Provide multiple inclusion protection
+5.6.7. Provide multiple inclusion protection
Explanation:
-------------------------------------------------------------------------------
-4.6.8. Use `extern "C"` when appropriate
+5.6.8. Use `extern "C"` when appropriate
Explanation:
-------------------------------------------------------------------------------
-4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
+5.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
Explanation:
Note: If you declare "file_list xyz;" (without the pointer), then including the
proper header file is necessary. If you only want to prototype a pointer,
-however, the header file is unneccessary.
+however, the header file is unnecessary.
-Status: Use with discrection.
+Status: Use with discretion.
-------------------------------------------------------------------------------
-4.7. General Coding Practices
+5.7. General Coding Practices
-4.7.1. Turn on warnings
+5.7.1. Turn on warnings
Explanation
-------------------------------------------------------------------------------
-4.7.2. Provide a default case for all switch statements
+5.7.2. Provide a default case for all switch statements
Explanation:
default :
log_error( ... );
- ... anomly code goes here ...
+ ... anomaly code goes here ...
continue; / break; / exit( 1 ); / etc ...
} /* end switch( hash_string( cmd ) ) */
switch statement. This API call *should* be included in a default statement.
Another Note: This is not so much a readability issue as a robust programming
-issue. The "anomly code goes here" may be no more than a print to the STDERR
+issue. The "anomaly code goes here" may be no more than a print to the STDERR
stream (as in load_config). Or it may really be an ABEND condition.
Status: Programmer discretion is advised.
-------------------------------------------------------------------------------
-4.7.3. Try to avoid falling through cases in a switch statement.
+5.7.3. Try to avoid falling through cases in a switch statement.
Explanation:
-------------------------------------------------------------------------------
-4.7.4. Use 'long' or 'short' Instead of 'int'
+5.7.4. Use 'long' or 'short' Instead of 'int'
Explanation:
-------------------------------------------------------------------------------
-4.7.5. Don't mix size_t and other types
+5.7.5. Don't mix size_t and other types
Explanation:
-------------------------------------------------------------------------------
-4.7.6. Declare each variable and struct on its own line.
+5.7.6. Declare each variable and struct on its own line.
Explanation:
variables; feel free to declare them on 1 line. You should, although, provide a
good comment on their functions.
-Status: developer-discrection.
+Status: developer-discretion.
-------------------------------------------------------------------------------
-4.7.7. Use malloc/zalloc sparingly
+5.7.7. Use malloc/zalloc sparingly
Explanation:
-Create a local stuct (on the stack) if the variable will live and die within
+Create a local struct (on the stack) if the variable will live and die within
the context of one function call.
Only "malloc" a struct (on the heap) if the variable's life will extend beyond
Example:
If a function creates a struct and stores a pointer to it in a
-list, then it should definately be allocated via `malloc'.
+list, then it should definitely be allocated via `malloc'.
-------------------------------------------------------------------------------
-4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
+5.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
Explanation:
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
-function to accomodate this.
+function to accommodate this.
Example:
The developer cannot be expected to provide `free'ing functions for C run-time
library functions ... such as `strdup'.
-Status: developer-discrection. The "main" use of this standard is for
-allocating and freeing data structures (complex or nested).
+Status: developer-discretion. The "main" use of this standard is for allocating
+and freeing data structures (complex or nested).
-------------------------------------------------------------------------------
-4.7.9. Add loaders to the `file_list' structure and in order
+5.7.9. Add loaders to the `file_list' structure and in order
Explanation:
-------------------------------------------------------------------------------
-4.7.10. "Uncertain" new code and/or changes to exitinst code, use FIXME
+5.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
Explanation:
If you have enough confidence in new code or confidence in your changes, but
-are not *quite* sure of the reprocussions, add this:
+are not *quite* sure of the repercussions, add this:
-/* FIXME: this code has a logic error on platform XYZ, * attempthing to fix */
-#ifdef PLATFORM ...changed code here... #endif
+/* FIXME: this code has a logic error on platform XYZ, * attempting to fix */ #
+ifdef PLATFORM ...changed code here... #endif
or:
/* FIXME: new code that *may* break something else... */ ...new code here...
Note: If you make it clear that this may or may not be a "good thing (tm)", it
-will be easier to identify and include in the project (or conversly exclude
+will be easier to identify and include in the project (or conversely exclude
from the project).
-------------------------------------------------------------------------------
-4.8. Addendum: Template for files and function comment blocks:
+5.8. Addendum: Template for files and function comment blocks:
Example for file comments:
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.18 2002/04/03 03:51:48 hal9 Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $";
/*********************************************************************
*
* File : $Source$
change the "Copyright" section to represent the rights you wish to maintain.
Note: The formfeed character that is present right after the comment flower box
-is handy for (X|GNU)Emacs users to skip the verbige and get to the heart of the
-code (via `forward-page' and `backward-page'). Please include it if you can.
+is handy for (X|GNU)Emacs users to skip the verbiage and get to the heart of
+the code (via `forward-page' and `backward-page'). Please include it if you
+can.
Example for file header comments:
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.18 2002/04/03 03:51:48 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $"
/*********************************************************************
*
* File : $Source$
-------------------------------------------------------------------------------
-5. Version Control Guidelines
+6. Version Control Guidelines
To be filled. note on cvs comments. Don't only comment what you did, but also
why you did it!
-------------------------------------------------------------------------------
-6. Testing Guidelines
+7. Testing Guidelines
To be filled.
-------------------------------------------------------------------------------
-6.1. Testplan for releases
+7.1. Testplan for releases
Explain release numbers. major, minor. developer releases. etc.
-------------------------------------------------------------------------------
-6.2. Test reports
+7.2. Test reports
Please submit test reports only with the test form at sourceforge. Three simple
steps:
-------------------------------------------------------------------------------
-7. Releasing a new version
+8. Releasing a new version
-To minimize trouble with distribution contents, webpage 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.
+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.
The following programs are required to follow this process: ncftpput (ncftp),
scp (ssh), gmake (GNU's version of make), autoconf, cvs, ???.
+Replace X, Y and Z with the actual version number (X = major, Y = minor, Z =
+point):
+
-------------------------------------------------------------------------------
-7.1. Before the Release
+8.1. Before the Release
-The following must be done by one of the developers prior to each new release:
+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.
- * Increment the version number in configure.in in CVS. Also, the RPM release
- number in configure.in. 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 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!
* If the default actionsfile has changed since last release, bump up its
version info in this line:
Then change the version info in doc/webserver/actions/index.php, line:
'$required_actions_file_version = "A.B";'
- * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z" (where
- X = major, Y = minor, Z = point). Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z
- (won't work) etc.
+ * Commit all files that were changed in the above steps!
- * The first package uploaded should be the official "tarball" release. This
- is built with the "make tarball-dist" Makefile target, and then can be
- uploaded with "make tarball-upload" (see below).
+ * 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).
-------------------------------------------------------------------------------
-7.2. Update the webserver
+8.2. Update the webserver
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
+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
make webserver
+This will do the upload to the webserver (www.privoxy.org).
+
Note that "make dok" (or "make redhat-dok") creates doc/webserver/user-manual,
-doc/webserver/developer-manual, doc/webserver/faq and doc/webserver/man-page
-automatically.
+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.)
+
+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.
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
-------------------------------------------------------------------------------
-7.3. SuSE or Red Hat
+8.3. SuSE or Red Hat
Ensure that you have the latest code version. Hence run:
- cd current
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.
To upload the package to Sourceforge, simply issue
- make suse-upload or make redhat-upload
+ make suse-upload (or make redhat-upload)
Go to the displayed URL and release the file publicly on Sourceforge.
-------------------------------------------------------------------------------
-7.4. OS/2
+8.4. OS/2
Ensure that you have the latest code version. Hence run:
- cd current
- 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
-
+ 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
+
-first.
+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
+from various sources like hobbes.nmsu.edu. Specificially, you will need
+autoheader, autoconf and sh tools. The packaging takes place with WarpIN,
+available from various sources, including its home page: xworkplace.
- autoheader && autoconf && ./configure
+Change directory to the os2setup directory. Edit the os2build.cmd file to set
+the final executable filename. For example,
+
+ installExeName='privoxyos2_setup_X.Y.Z.exe'
-Then do FIXME.
+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.
+Upload this anonymously to uploads.sourceforge.net/incoming, create a release
+for it, and you're done.
-------------------------------------------------------------------------------
-7.5. Solaris
+8.5. Solaris
Login to Sourceforge's compilefarm via ssh
Choose the right operating system (not the Debian one). If you have downloaded
Privoxy before,
- cd current
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:
-------------------------------------------------------------------------------
-7.6. Windows
+8.6. Windows
-Ensure that you have the latest code version. Hence run
+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.
- cd current
- 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
+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 .
-Run:
+(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).
- autoheader && autoconf && ./configure
+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
-Then do FIXME.
+Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
+upload it to SourceForge.
-------------------------------------------------------------------------------
-7.7. Debian
+8.7. Debian
Ensure that you have the latest code version. Hence run:
- cd current
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.8. Mac OSX
+8.8. Mac OSX
-Login to Sourceforge's compilefarm via ssh
-
- ssh cf.sourceforge.net
-
+Ensure that you have the latest code version. Hence run:
-Choose the right operating system. 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 ..
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
+
- cd current
- 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
-
+From the osxsetup directory, run:
-If not, please checkout Privoxy via CVS first. Run:
-
- autoheader && autoconf && ./configure
+ build
-Then run:
+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
+further processing by PackageMaker.
+
+Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the
+package name to match the release, and hit the "Create package" button. If you
+specify ./Privoxy.pkg as the output package name, you can then create the
+distributable zip file with the command:
- make macosx-dist
+zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
-which creates a gzip'ed tar archive. Sadly, you cannot use make macosx-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.
+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.
-------------------------------------------------------------------------------
-7.9. FreeBSD
+8.9. FreeBSD
Change the version number of Privoxy in the configure.in file. Run:
ssh cf.sourceforge.net
-Choose the right operating system. If you have downloaded Privoxy before,
+Choose the right operating system.
- cd current
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:
+Run:
autoheader && autoconf && ./configure
-------------------------------------------------------------------------------
-7.10. Tarball
+8.10. Tarball
-Ensure that you have the latest code version. Hence run:
+Ensure that you have the right code version. Hence run:
- cd current
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:
- make clobber
autoheader && autoconf && ./configure
-------------------------------------------------------------------------------
-7.11. HP-UX 11
+8.11. HP-UX 11
Ensure that you have the latest code version. Hence run:
- cd current
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.12. Amiga OS
+8.12. Amiga OS
Ensure that you have the latest code version. Hence run:
- cd current
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.13. AIX
+8.13. AIX
Login to Sourceforge's compilefarm via ssh:
Choose the right operating system. If you have downloaded Privoxy before:
- cd current
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:
-------------------------------------------------------------------------------
-8. Contact the developers
+9. Contacting the developers, Bug Reporting and Feature Requests
-Please see the contact page in the user-manual for details.
+We value your feedback. However, to provide you with the best support, please
+note:
+ * Use the Sourceforge Support Forum to get help:
+
+ http://sourceforge.net/tracker/?group_id=11118&atid=211118
+
+
+ * 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.
+
+
+ * 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.
+
+
+ * For any other issues, feel free to use the mailing lists:
+
+ http://sourceforge.net/mail/?group_id=11118.
+
+
+ Anyone interested in actively participating in development and related
+ discussions can also join the appropriate mailing list. Archives are
+ available, too.
+
-------------------------------------------------------------------------------
-9. Copyright and History
+10. Copyright and History
-Please see the user-manual for information on Copyright and History.
+10.1. Copyright
+
+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.
+
+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.
+
+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.
-------------------------------------------------------------------------------
-10. See also
+10.2. History
+
+Privoxy is evolved, and derived from, the Internet Junkbuster, with many
+improvments and enhancements over the original.
+
+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 ;-).
+
+-------------------------------------------------------------------------------
+
+11. See also
+
+Other references and sites of interest to Privoxy users:
+
+http://www.privoxy.org/, The Privoxy Home page.
+
+http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on
+Sourceforge.
+
+http://p.p/, access Privoxy from your browser. Alternately, http://
+config.privoxy.org may work in some situations where the first does not.
+
+http://p.p/, and select "actions file feedback system" to submit "misses" to
+the developers.
+
+http://www.junkbusters.com/ht/en/cookies.html
+
+http://www.waldherr.org/junkbuster/
+
+http://privacy.net/analyze/
+
+http://www.squid-cache.org/
-Please see the user-manual for others references.
+
projects / privoxy.git / blobdiff