Privoxy Developer Manual
-[ Copyright © 2001, 2002 by Privoxy Developers ]
+[ Copyright 2001-2007 by Privoxy Developers ]
-$Id: developer-manual.txt,v 1.32.2.7 2004/01/30 23:46:56 oes Exp $
+$Id: developer-manual.sgml,v 2.13 2007/10/30 17:59:31 fabiankeil Exp $
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.
+join the team. Note that it's currently out of date and may not be entirely
+correct. As always, patches are welcome.
Please note that this document is constantly evolving. This copy represents the
-state at the release of version 3.0.3. You can find the latest version of the
+state at the release of version 3.0.7. 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
'free'
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
+ or XXX
4.8. Addendum: Template for files and function comment blocks:
8. Contacting the developers, Bug Reporting and Feature Requests
8.1. Get Support
- 8.2. Report Bugs
+ 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. Report Ads or Other Actions-Related Problems
- 8.5. Other
+ 8.4. Other
9. Privoxy Copyright, License and History
1. Introduction
-Privoxy, as an heir to Junkbuster, is an Open Source project and licensed under
-the GPL. As such, Privoxy development is potentially open to anyone who has the
-time, knowledge, and desire to contribute in any capacity. Our goals are simply
-to continue the mission, to improve Privoxy, and to make it available to as
-wide an audience as possible.
+Privoxy, as an heir to Junkbuster, is a Free Software project and the code is
+licensed under the GPL. As such, Privoxy development is potentially open to
+anyone who has the time, knowledge, and desire to contribute in any capacity.
+Our goals are simply to continue the mission, to improve Privoxy, and to make
+it available to as wide an audience as possible.
-One does not have to be a programmer to contribute. Packaging, testing, and
-porting, are all important jobs as well.
+One does not have to be a programmer to contribute. Packaging, testing,
+documenting and porting, are all important jobs as well.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1.1. Quickstart to Privoxy Development
refer to the extensive comments in the source code. In fact, reading the code
is recommended in any case.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
2. The CVS Repository
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
-cvs.ijbswa.sourceforge.net, the repository is called ijbswa, and the source
+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://
-cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/, which might help with
-visualizing how these pieces fit together.
+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"
bugfixes, which have had prior testing before being committed to CVS. (See
Version Numbers below for details on versioning.)
-This will result in at least two active branches, which means there may be
-occasions that require the same (or similar) item to be checked into to two
-different places (assuming its a bugfix and needs fixing in both the stable and
-unstable trees). This also means that in order to have access to both trees,
-both will have to be checked out separately. Use the cvs -r flag to check out a
-branch, e.g: cvs co -r v_3_0_branch current.
+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
Basic Guidelines, for all branches:
- * Never (read: never, ever) be tempted to commit that small change without
- testing it thoroughly first. When we're close to a public release, ask a
- fellow developer to review your changes.
+ • 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.
- * Your commit message should give a concise overview of what you changed (no
+ • 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.
- * Don't use the same message on multiple files, unless it equally applies to
+ • Don't use the same message on multiple files, unless it equally applies to
all those files.
- * If your changes span multiple files, and the code won't recompile unless
+ • 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.
- * Before changing things on CVS, make sure that your changes are in line with
+ • 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
+ • 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.
-Stable branches are handled with more care, especially after the initial *.*.0
-release, and we are just in bugfix mode. In addition to the above, the below
-applies only to the stable branch (currently the v_3_0_branch branch):
-
- * Do not commit anything unless your proposed changes have been well tested
- first, preferably by other members of the project, or have prior approval
- of the project leaders or consensus of the devel list.
-
- * Where possible, bugfixes and changes should be tested in the main
- development trunk first. There may be occasions where this is not feasible,
- though.
-
- * Alternately, proposed changes can be submitted as patches to the patch
- tracker on Sourceforge first: http://sourceforge.net/tracker/?group_id=
- 11118&atid=311118. Then ask for peer review.
-
- * Do not even think about anything except bugfixes. No new features!
-
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
3. Documentation Guidelines
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), 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 (at present Hal).
+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
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, INSTALL) are maintained as plain
-text files in the top-level source directory. At least for the time being.
+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
this after the $VERSION and other release specific data in configure.in has
been updated (this is done just prior to a new release).
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
3.1. Quickstart to Docbook and SGML
You might also find "Writing Documentation Using DocBook - A Crash Course"
useful.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
3.2. Privoxy Documentation Style
Here it is:
- * All tags should be lower case.
+ • All tags should be lower case.
- * Tags delimiting a block of text (even small blocks) should be on their own
+ • Tags delimiting a block of text (even small blocks) should be on their own
line. Like:
<para>
Just to <emphasis>emphasize</emphasis>, some text goes here.
- * Tags should be nested and step indented for block text like: (except
+ • Tags should be nested and step indented for block text like: (except
in-line tags)
<para>
This makes it easier to find the text amongst the tags ;-)
- * Use white space to separate logical divisions within a document, like
+ • 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>
+ • 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
+ • 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
+ • 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, TML, and PDF, but others are always a future possibility. Be
+ • Our documents are available in differing formats. Right now, they are just
+ 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>.
My favorite site is <ulink url="http://example.com">example.com</ulink>.
- * All documents should be spell checked occasionally. aspell can check SGML
+ • All documents should be spell checked occasionally. aspell can check SGML
with the -H option. (ispell I think too.)
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
3.3. Privoxy Custom Entities
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:
+ • Re- "boilerplate" text entities are defined like:
<!entity supported SYSTEM "supported.sgml">
semi-colon), and the contents will be dumped into the finished doc at that
point.
- * Commonly used "internal entities":
+ • Commonly used "internal entities":
- p-version: the Privoxy version string, e.g. "3.0.3".
+ p-version: the Privoxy version string, e.g. "3.0.7".
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").
There are others in various places that are defined for a specific purpose.
Read the source!
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4. Coding Guidelines
development and product efficiencies then we can solve more of the request for
changes/improvements and in general feel good about ourselves. ;->
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.2. Using Comments
Explanation:
Comment as much as possible without commenting the obvious. For example do not
-comment "aVariable is equal to bVariable". Instead explain why aVariable should
-be equal to the bVariable. Just because a person can read code does not mean
-they will understand why or what is being done. A reader may spend a lot more
-time figuring out what is going on when a simple comment or explanation would
-have prevented the extra research. Please help your brother IJB'ers out!
+comment "variable_a is equal to variable_b". Instead explain why variable_a
+should be equal to the variable_b. Just because a person can read code does not
+mean they will understand why or what is being done. A reader may spend a lot
+more time figuring out what is going on when a simple comment or explanation
+would have prevented the extra research. Please help your brother IJB'ers out!
The comments will also help justify the intent of the code. If the comment
describes something different than what the code is doing then maybe a
Example:
/* if page size greater than 1k ... */
-if ( PageLength() > 1024 )
+if ( page_length() > 1024 )
{
... "block" the page up ...
}
/* if page size is small, send it in blocks */
-if ( PageLength() > 1024 )
+if ( page_length() > 1024 )
{
... "block" the page up ...
}
is actually being done.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.2.2. Use blocks for comments
/*********************************************************************
* This will stand out clearly in your code!
*********************************************************************/
-if ( thisVariable == thatVariable )
+if ( this_variable == that_variable )
{
- DoSomethingVeryImportant();
+ do_something_very_important();
}
/* unfortunately, this may not */
-if ( thisVariable == thatVariable )
+if ( this_variable == that_variable )
{
- DoSomethingVeryImportant();
+ do_something_very_important();
}
-if ( thisVariable == thatVariable ) /* this may not either */
+if ( this_variable == that_variable ) /* this may not either */
{
- DoSomethingVeryImportant();
+ do_something_very_important();
}
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
* This will stand out clearly in your code,
* But the second example won't.
*********************************************************************/
-if ( thisVariable == thatVariable )
+if ( this_variable == this_variable )
{
- DoSomethingVeryImportant();
+ do_something_very_important();
}
-if ( thisVariable == thatVariable ) /*can you see me?*/
+if ( this_variable == this_variable ) /*can you see me?*/
{
- DoSomethingVeryImportant(); /*not easily*/
+ do_something_very_important(); /*not easily*/
}
if ( 1 == X )
{
- DoSomethingVeryImportant();
+ do_something_very_important();
}
-short DoSomethingVeryImportant(
+short do_something_very_important(
short firstparam, /* represents something */
short nextparam /* represents something else */ )
{
...code here...
-} /* -END- DoSomethingVeryImportant */
+} /* -END- do_something_very_important */
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.2.4. Comment each logical step
Most "for", "while", "do", etc... loops _probably_ need a comment. After all,
these are usually major logic containers.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.2.5. Comment All Functions Thoroughly
should contain the information presented in the addendum section of this
document.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.2.6. Comment at the end of braces if the content is more than one screen
length
if ( 1 == X )
{
- DoSomethingVeryImportant();
+ do_something_very_important();
...some long list of commands...
} /* -END- if x is 1 */
if ( 1 == X )
{
- DoSomethingVeryImportant();
+ do_something_very_important();
...some long list of commands...
} /* -END- if ( 1 == X ) */
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.3. Naming Conventions
int msiis5hack = 0; int msIis5Hack = 0;
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.3.2. Function Names
int loadSomeFile( struct client_state *csp )
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.3.3. Header file prototypes
(.c) int load_aclfile( struct client_state *csp )
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.3.4. Enumerations, and #defines
#endif /* def FEATURE_FORCE */
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.3.5. Constants
#define UseImageList 1
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.4. Using Space
}
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.4.2. ALL control statements should have a block
if ( this == that )
{
- DoSomething();
- DoSomethingElse();
+ do_something();
+ do_something_else();
}
Instead of:
-if ( this == that ) DoSomething(); DoSomethingElse();
+if ( this == that ) do_something(); do_something_else();
or
-if ( this == that ) DoSomething();
+if ( this == that ) do_something();
Note: The first example in "Instead of" will execute in a manner other than
that which the developer desired (per indentation). Using code braces would
have prevented this "feature". The "explanation" and "exception" from the point
above also applies.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.4.3. Do not belabor/blow-up boolean expressions
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
Example:
-int firstValue = 0;
-int someValue = 0;
-int anotherValue = 0;
-int thisVariable = 0;
+int first_value = 0;
+int some_value = 0;
+int another_value = 0;
+int this_variable = 0;
-if ( thisVariable == thatVariable )
+if ( this_variable == this_variable )
-firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
+first_value = old_value + ( ( some_value - another_value ) - whatever )
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.4.5. Don't use white space around structure operators
Example:
-aStruct->aMember;
-aStruct.aMember;
-FunctionName();
+a_struct->a_member;
+a_struct.a_member;
+function_name();
-Instead of: aStruct -> aMember; aStruct . aMember; FunctionName ();
+Instead of: a_struct -> a_member; a_struct . a_member; function_name ();
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.4.6. Make the last brace of a function stand out
int function1( ... )
{
...code...
- return( retCode );
+ return( ret_code );
} /* -END- function1 */
Instead of:
-int function1( ... ) { ...code... return( retCode ); } int function2( ... ) { }
+int function1( ... ) { ...code... return( ret_code ); } int function2( ... ) {
+}
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
Status: developer-discretion on the number of blank lines. Enforced is the end
of function comments.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.4.7. Use 3 character indentions
}
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.5. Initializing
Example:
-short anShort = 0;
-float aFloat = 0;
+short a_short = 0;
+float a_float = 0;
struct *ptr = NULL;
Note: It is much easier to debug a SIGSEGV if the message says you are trying
-to access memory address 00000000 and not 129FA012; or arrayPtr[20] causes a
-SIGSEV vs. arrayPtr[0].
+to access memory address 00000000 and not 129FA012; or array_ptr[20] causes a
+SIGSEV vs. array_ptr[0].
Status: developer-discretion if and only if the variable is assigned a value
"shortly after" declaration.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.6. Functions
Example:
-ShouldWeBlockThis();
-ContainsAnImage();
-IsWebPageBlank();
+should_we_block_this();
+contains_an_image();
+is_web_page_blank();
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.6.2. Always specify a return type for a function.
return for a function when the return has a purpose, and create a void return
type if the function does not need to return anything.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.6.3. Minimize function calls when iterating by using variables
Example:
-for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
+for ( size_t cnt = 0; cnt < block_list_length(); cnt++ )
{
....
}
Note: Unfortunately, this makes a function call for each and every iteration.
This increases the overhead in the program, because the compiler has to look up
the function each time, call it, and return a value. Depending on what occurs
-in the blockListLength() call, it might even be creating and destroying
+in the block_list_length() call, it might even be creating and destroying
structures with each iteration, even though in each case it is comparing "cnt"
-to the same value, over and over. Remember too - even a call to blockListLength
-() is a function call, with the same overhead.
+to the same value, over and over. Remember too - even a call to
+block_list_length() is a function call, with the same overhead.
Instead of using a function call during the iterations, assign the value to a
variable, and evaluate using the variable.
Example:
-size_t len = blockListLength();
+size_t len = block_list_length();
-for ( size_t cnt = 0; cnt < len; cnt ++ )
+for ( size_t cnt = 0; cnt < len; cnt++ )
{
....
}
-Exceptions: if the value of blockListLength() *may* change or could
+Exceptions: if the value of block_list_length() *may* change or could
*potentially* change, then you must code the function call in the for/while
loop.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.6.4. Pass and Return by Const Reference
Both these pointers are *const*! If the c runtime library maintainers do it, we
should too.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.6.5. Pass and Return by Value
would not work. So, to be consistent, we should declare all prototypes with
"pass by value": int load_aclfile( struct client_state *csp )
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.6.6. Names of include files
Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
This duplicates the #include "file.h" behavior.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.6.7. Provide multiple inclusion protection
#endif /* ndef PROJECT_H_INCLUDED */
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.6.8. Use `extern "C"` when appropriate
#endif /* def __cplusplus */
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
Status: Use with discretion.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.7. General Coding Practices
as possible. With GCC, the switch is "-Wall". Try and fix as many warnings as
possible.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.7.2. Provide a default case for all switch statements
Another Note: This is not so much a readability issue as a robust programming
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.
+stream (as in load_config). Or it may really be an abort condition.
Status: Programmer discretion is advised.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.7.3. Try to avoid falling through cases in a switch statement.
If you choose to allow fall through, you should comment both the fact of the
fall through and reason why you felt it was necessary.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.7.4. Use 'long' or 'short' Instead of 'int'
forget the exact typedefs now). Should we add these to IJB now that we have a
"configure" script?
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.7.5. Don't mix size_t and other types
The type of size_t varies across platforms. Do not make assumptions about
whether it is signed or unsigned, or about how long it is. Do not compare a
size_t against another variable of a different type (or even against a
-constant) without casting one of the values. Try to avoid using size_t if you
-can.
+constant) without casting one of the values.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.7.6. Declare each variable and struct on its own line.
eliminate
Exceptions: when you want to declare a bunch of loop variables or other trivial
-variables; feel free to declare them on 1 line. You should, although, provide a
-good comment on their functions.
+variables; feel free to declare them on one line. You should, although, provide
+a good comment on their functions.
Status: developer-discretion.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.7.7. Use malloc/zalloc sparingly
list, then it should definitely be allocated via `malloc'.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
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
coming before PCRS tests. But since POPUPs can also be referred to as
KILLPOPUPs, it is clear that it should come first.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-4.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 or XXX
Explanation:
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:
Example for file comments:
-const char FILENAME_rcs[] = "$Id: developer-manual.txt,v 1.32.2.7 2004/01/30 23:46:56 oes Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 2.13 2007/10/30 17:59:31 fabiankeil Exp $";
/*********************************************************************
*
- * File : $Source: /cvsroot/ijbswa/current/doc/text/developer-manual.txt,v $
+ * 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-2007 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: developer-manual.txt,v $
- * Revision 1.32.2.7 2004/01/30 23:46:56 oes
- * Re-generated from sgml source
- *
+ * $Log$
*
*********************************************************************/
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.txt,v 1.32.2.7 2004/01/30 23:46:56 oes Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.13 2007/10/30 17:59:31 fabiankeil Exp $"
/*********************************************************************
*
- * File : $Source: /cvsroot/ijbswa/current/doc/text/developer-manual.txt,v $
+ * 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-2007 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: developer-manual.txt,v $
- * Revision 1.32.2.7 2004/01/30 23:46:56 oes
- * Re-generated from sgml source
- *
+ * $Log$
*
*********************************************************************/
Note: If we all follow this practice, we should be able to parse our code to
create a "self-documenting" web page.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
5. Testing Guidelines
To be filled.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
5.1. Testplan for releases
2. Remove any file that was left over. This includes (but is not limited to)
- + /var/log/privoxy
+ □ /var/log/privoxy
- + /etc/privoxy
+ □ /etc/privoxy
- + /usr/sbin/privoxy
+ □ /usr/sbin/privoxy
- + /etc/init.d/privoxy
+ □ /etc/init.d/privoxy
- + /usr/doc/privoxy*
+ □ /usr/doc/privoxy*
3. Install the rpm. Any error messages?
6. Remove the rpm. Any error messages? All files removed?
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
5.2. Test reports
Please submit test reports only with the test form at sourceforge. Three simple
steps:
- * Select category: the distribution you test on.
+ • Select category: the distribution you test on.
- * Select group: the version of Privoxy that we are about to release.
+ • Select group: the version of Privoxy that we are about to release.
- * Fill the Summary and Detailed Description with something intelligent (keep
+ • Fill the Summary and Detailed Description with something intelligent (keep
it short and precise).
Do not mail to the mailing list (we cannot keep track on issues there).
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6. Releasing a New Version
The following programs are required to follow this process: ncftpput (ncftp),
scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.1. Version numbers
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
+ • 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
+ • 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
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
+ • 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
main trunk, and the stable release branch, which is v_3_0_branch at the
moment).
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
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
+ • 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. Announce the freeze so that nobody will interfere with
last minute changes.
- * Increment the version number (point from odd to even in development
+ • 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 default.action has changed since last release (i.e. software release or
+ • 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:
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
+ • 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
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.
+ • 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
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
+ • All developers should look at the ChangeLog and make sure noteworthy
changes are referenced.
- * Commit all files that were changed in the above steps!
+ • 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
+ • 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.
- * If the release was in a development branch, increase the point version from
+ • 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
+ • 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).
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3. Building and Releasing the Packages
mkdir dist # delete or choose different name if it already exists
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 current
+ 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
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.
+┌─────────────────────────────────────────────────────────────────────────────┐
+│ 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 find additional instructions for the source tarball and the individual
platform dependent binary packages below. And details on the Sourceforge
release process below that.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.1. Note on Privoxy Packaging
Please keep these general guidelines in mind when putting together your
package. These apply to all platforms!
- * Privoxy requires write access to: all *.action files, all logfiles, and the
+ • 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:
+ • Please include up to date documentation. At a bare minimum:
LICENSE (top-level directory)
directory with privoxy-index.html, (i.e. one level up from the manual
directories).
- * user.action is designed for local preferences. Make sure this does not get
- overwritten!
+ • 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 should be installed as the new defaults, but all
+ • 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 :-)
+ 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
+ • 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.
+ • 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.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.2. Source Tarball
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
displayed URL and release the file publicly on Sourceforge. Use the release
notes and change log from the source tarball package.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.4. OS/2
directory. (See "Building and releasing packages" above). Then get the OS/2
Setup module:
- 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
for it, and you're done. Use the release notes and Change Log from the source
tarball package.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.5. Solaris
archive to Sourceforge's ftp server and release the file publicly. Use the
release notes and Change Log from the source tarball package.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.6. Windows
directory. (See "Building and releasing packages" above). Then get the Windows
setup module:
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
+ 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
upload it to SourceForge. When releasing the package on SourceForge, use the
release notes and Change Log from the source tarball package.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.7. Debian
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:
- debchange -v 3.0.3-stable-1 "New upstream version"
+ debchange -v 3.0.7-beta-1 "New upstream version"
Then, run:
dpkg-buildpackage -rfakeroot -us -uc -b
-This will create ../privoxy_3.0.3-stable-1_i386.deb which can be uploaded. To
+This will create ../privoxy_3.0.7-beta-1_i386.deb which can be uploaded. To
upload the package to Sourceforge, simply issue
make debian-upload
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.8. Mac OSX
directory. (See "Building and releasing packages" above). Then get the Mac OSX
setup module:
- 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
Then run:
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.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.9. FreeBSD
archive to Sourceforge's ftp server and release the file publicly. Use the
release notes and Change Log from the source tarball package.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.10. HP-UX 11
Then do FIXME.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.11. Amiga OS
Then do FIXME.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.3.12. AIX
archive to Sourceforge's ftp server and release the file publicly. Use the
release notes and Change Log from the source tarball package.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.4. Uploading and Releasing Your Package
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:
- * Upload to: ftp://upload.sourceforge.net/incoming
+ • Upload to: ftp://upload.sourceforge.net/incoming
- * user: anonymous
+ • user: anonymous
- * password: ijbswa-developers@lists.sourceforge.net
+ • password: ijbswa-developers@lists.sourceforge.net
Or use the make targets as described above.
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.3 (beta).
+3.0.7 (beta).
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
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.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
6.5. After the Release
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).
+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.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
7. Update the Webserver
branches or versions. The publicly posted docs should be in sync with the last
official release.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
8. Contacting the developers, Bug Reporting and Feature Requests
configuration. However, please note the following hints, so we can provide you
with the best support:
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
8.1. Get Support
All users are of course welcome to discuss their issues on the users mailing
list, where the developers also hang around.
--------------------------------------------------------------------------------
+Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
+addresses have to be accepted manually by a moderator. This may cause a delay
+of several days and if you use a subject that doesn't clearly mention Privoxy
+or one of its features, your message may be accidentally discarded as spam.
+
+If you aren't subscribed, you should therefore spend a few seconds to come up
+with a proper subject. Additionally you should make it clear that you want to
+get CC'd. Otherwise some responses will be directed to the mailing list only,
+and you won't see them.
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+8.2. Reporting Problems
+
+"Problems" for our purposes, come in two forms:
+
+ • 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.
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-8.2. Report Bugs
+8.2.2. Reporting Bugs
-Please report all bugs only through our bug tracker: http://sourceforge.net/
-tracker/?group_id=11118&atid=111118.
+Please report all bugs through our bug tracker: http://sourceforge.net/tracker
+/?group_id=11118&atid=111118.
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.
+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 or
+documented behaviour that just happens to be different than what you expected.
+If unsure, try toggling off Privoxy, and see if the problem persists.
-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.
-The appendix of the user manual also has helpful information on action
-debugging. If you are using your own custom configuration, please try the stock
-configs to see if the problem is configuration related.
+If you are using your own custom configuration, please try the stock configs to
+see if the problem is configuration related. If you're having problems with a
+feature that is disabled by default, please ask around on the mailing list if
+others can reproduce the problem.
-If not using the latest version, chances are that the bug has been found and
+If you aren't using the latest Privoxy 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, but this is not required for reporting.
+upgrade to the latest version (or even the latest CVS snapshot) and verify that
+your bug still exists.
--------------------------------------------------------------------------------
+Please be sure to provide the following information:
-8.3. Request New Features
+ • The exact Privoxy version you are using (if you got the source from CVS,
+ please also provide the source code revisions as shown in http://
+ config.privoxy.org/show-version).
-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.
+ • The operating system and versions you run Privoxy on, (e.g. Windows XP
+ SP2), if you are using a Unix flavor, sending the output of "uname -a"
+ should do, in case of GNU/Linux, please also name the distribution.
--------------------------------------------------------------------------------
+ • The name, platform, and version of the browser you were using (e.g.
+ Internet Explorer v5.5 for Mac).
-8.4. Report Ads or Other Actions-Related Problems
+ • The URL where the problem occurred, or some way for us to duplicate the
+ problem (e.g. http://somesite.example.com/?somethingelse=123).
-Please send feedback on ads that slipped through, innocent images that were
-blocked, and any other problems relating to the default.action file through our
-actions feedback mechanism located at http://www.privoxy.org/actions/. On this
-page, you will also find a bookmark which will take you back there from any
-troubled site and even pre-fill the form!
+ • Whether your version of Privoxy is one supplied by the Privoxy developers
+ via SourceForge, or if you got your copy somewhere else.
-New, improved default.action files will 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.
+ • Whether you are using Privoxy in tandem with another proxy such as Tor. If
+ so, please temporary disable the other proxy to see if the symptoms change.
+
+ • Whether you are using a personal firewall product. If so, does Privoxy work
+ without it?
+
+ • 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).
+
+You don't have to tell us your actual name when filing a problem report, but
+please use a nickname so we can differentiate between your messages and the
+ones entered by other "anonymous" users that may respond to your request if
+they have the same problem or already found a solution.
+
+Please also check the status of your request a few days after submitting it, as
+we may request additional information. If you use a SF id, you should
+automatically get a mail when someone responds to your request.
--------------------------------------------------------------------------------
+The appendix of the Privoxy User Manual also has helpful information on
+understanding actions, and action debugging.
-8.5. Other
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+8.3. Request New Features
+
+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
mailing lists, including list archives, at: http://sourceforge.net/mail/?
group_id=11118.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
9. Privoxy Copyright, License and History
-Copyright © 2001 - 2004 by Privoxy Developers <developers@privoxy.org>
+Copyright 2001-2007 by Privoxy Developers <
+ijbswa-developers@lists.sourceforge.net>
-Some source code is based on code Copyright © 1997 by Anonymous Coders and
+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
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
+ Foundation, Inc. 51 Franklin Street, Fifth Floor
+ Boston, MA 02110-1301
USA
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
9.2. History
-In the beginning, there was the Internet Junkbuster, by Anonymous Coders and
-Junkbusters Corporation. It saved many users a lot of pain in the early days of
-web advertising and user tracking.
+A long 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 users to consume ads, give up autonomy over their browsing, and for
-spying on them, kept 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.
+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.
So Stefan Waldherr started maintaining an improved version of the software, to
which eventually a number of people contributed patches. It could already
The result of this is Privoxy, whose first stable version, 3.0, was released
August, 2002.
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
10. See also
http://config.privoxy.org/, the web-based user interface. Privoxy must be
running for this to work. Shortcut: http://p.p/
-http://www.privoxy.org/actions/, to submit "misses" to the developers.
-
-http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool and fun
-ideas from Privoxy users.
+http://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit "misses"
+and other configuration related suggestions 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/ijb.html, the original Internet Junkbuster.
-http://www.waldherr.org/junkbuster/, Stefan Waldherr's version of Junkbuster,
-from which Privoxy was derived.
+http://privacy.net/, a useful site to check what information about you is
+leaked while you browse the web.
-http://privacy.net/analyze/, a useful site to check what information about you
-is leaked while you browse the web.
-
-http://www.squid-cache.org/, a very popular caching proxy, which is often used
+http://www.squid-cache.org/, a popular caching proxy, which is often used
together with Privoxy.
+http://www.pps.jussieu.fr/~jch/software/polipo/, Polipo is a caching proxy with
+advanced features like pipelining, multiplexing and caching of partial
+instances. In many setups it can be used as Squid replacement.
+
+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