Privoxy Developer Manual
-Copyright © 2001-2006 by Privoxy Developers
+[ Copyright 2001-2008 by Privoxy Developers ]
-$Id: developer-manual.sgml,v 2.9 2006/09/14 02:30:07 hal9 Exp $
+$Id: developer-manual.sgml,v 2.15 2008/01/19 15:03:05 hal9 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.5. You can find the latest version of the
+state at the release of version 3.0.8. 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
-
+
1.1. Quickstart to Privoxy Development
-
+
2. The CVS Repository
-
+
2.1. Access to CVS
2.2. Branches
2.3. CVS Commit Guidelines
-
+
3. Documentation Guidelines
-
+
3.1. Quickstart to Docbook and SGML
3.2. Privoxy Documentation Style
3.3. Privoxy Custom Entities
-
+
4. Coding Guidelines
-
+
4.1. Introduction
4.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.5. Comment All Functions Thoroughly
4.2.6. Comment at the end of braces if the content is more than one
screen length
-
+
4.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
-
+
4.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.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
-
+
4.5. Initializing
-
+
4.5.1. Initialize all variables
-
+
4.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.8. Use `extern "C"` when appropriate
4.6.9. Where Possible, Use Forward Struct Declaration Instead of
Includes
-
+
4.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.
'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:
-
+
5. Testing Guidelines
-
+
5.1. Testplan for releases
5.2. Test reports
-
+
6. Releasing a New Version
-
+
6.1. Version numbers
6.2. Before the Release: Freeze
6.3. Building and Releasing the Packages
-
+
6.3.1. Note on Privoxy Packaging
6.3.2. Source Tarball
6.3.3. SuSE, Conectiva or Red Hat RPM
6.3.10. HP-UX 11
6.3.11. Amiga OS
6.3.12. AIX
-
+
6.4. Uploading and Releasing Your Package
6.5. After the Release
-
+
7. Update the Webserver
8. Contacting the developers, Bug Reporting and Feature Requests
-
+
8.1. Get Support
8.2. Reporting Problems
-
+
8.2.1. Reporting Ads or Other Configuration Problems
8.2.2. Reporting Bugs
-
+
8.3. Request New Features
8.4. Other
-
+
9. Privoxy Copyright, License and History
-
+
9.1. License
9.2. History
-
+
10. See also
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.
-------------------------------------------------------------------------------
prior to each stable series (e.g. 3.0.x), a branch is created just for stable
series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc). Once the initial stable
release of any stable branch has taken place, this branch is only used for
-bugfixes, which have had prior testing before being committed to CVS. (See
+bugfixes, which have had prior testing before being committed to CVS. (See
Version Numbers below for details on versioning.)
At one time there were two distinct branches: stable and unstable. The more
* 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
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
all those files.
-
+
* 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
the team's general consensus on what should be done.
-
+
* Note that near a major public release, we get more cautious. There is
always the possibility to submit a patch to the patch tracker instead.
-
+
-------------------------------------------------------------------------------
3. Documentation Guidelines
All formal documents are maintained in Docbook SGML and located in the doc/
source/* directory. You will need Docbook, the Docbook DTD's and the Docbook
modular stylesheets (or comparable alternatives), and either jade or openjade
-(recommended) installed in order to build docs from source. Currently there is
+(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, INSTALL, privoxy.1 (man page), and config files are also now
maintained as Docbook SGML. These files, when built, in the top-level source
1. First, build the docs by running make dok (or alternately make redhat-dok).
For PDF docs, do make dok-pdf.
-
+
2. Run make webserver which copies all files from doc/webserver to the
sourceforge webserver via scp.
-
+
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
Some common elements that you likely will use:
-<para></para>, paragraph delimiter. Most text needs to be within paragraph
-elements (there are some exceptions).
-<emphasis></emphasis>, the stylesheets make this italics.
-<filename></filename>, files and directories.
-<command></command>, command examples.
-<literallayout></literallayout>, like <pre>, more or less.
-<itemizedlist></itemizedlist>, list with bullets.
-<listitem></listitem>, member of the above.
-<screen></screen>, screen output, implies <literallayout>.
-<ulink url="example.com"></ulink>, like HTML <a> tag.
-<quote></quote>, for, doh, quoting text.
+<para></para>, paragraph delimiter. Most text needs to be within paragraph
+elements (there are some exceptions).
+<emphasis></emphasis>, the stylesheets make this italics.
+<filename></filename>, files and directories.
+<command></command>, command examples.
+<literallayout></literallayout>, like <pre>, more or less.
+<itemizedlist></itemizedlist>, list with bullets.
+<listitem></listitem>, member of the above.
+<screen></screen>, screen output, implies <literallayout>.
+<ulink url="example.com"></ulink>, like HTML <a> tag.
+<quote></quote>, for, doh, quoting text.
Look at any of the existing docs for examples of all these and more.
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>
</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, 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>.
-
+
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.)
-
+
-------------------------------------------------------------------------------
3.3. Privoxy Custom Entities
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. "3.0.5".
- p-status: the project status, either "alpha", "beta", or "stable".
- p-not-stable: use to conditionally include text in "not stable" releases
- (e.g. "beta").
- p-stable: just the opposite.
- p-text: this doc is only generated as text.
-
+
+ p-version: the Privoxy version string, e.g. "3.0.8".
+ 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!
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 )
-{
- ... "block" the page up ...
-}
-
-/* if page size is small, send it in blocks */
-if ( PageLength() > 1024 )
-{
- ... "block" the page up ...
-}
-
-This demonstrates 2 cases of "what not to do". The first is a
-"syntax comment". The second is a comment that does not fit what
-is actually being done.
+/* if page size greater than 1k ... */
+if ( page_length() > 1024 )
+{
+ ... "block" the page up ...
+}
+
+/* if page size is small, send it in blocks */
+if ( page_length() > 1024 )
+{
+ ... "block" the page up ...
+}
+
+This demonstrates 2 cases of "what not to do". The first is a
+"syntax comment". The second is a comment that does not fit what
+is actually being done.
+
-------------------------------------------------------------------------------
Example:
-/*********************************************************************
- * This will stand out clearly in your code!
- *********************************************************************/
-if ( thisVariable == thatVariable )
-{
- DoSomethingVeryImportant();
-}
-
-
-/* unfortunately, this may not */
-if ( thisVariable == thatVariable )
-{
- DoSomethingVeryImportant();
-}
-
-
-if ( thisVariable == thatVariable ) /* this may not either */
-{
- DoSomethingVeryImportant();
-}
+/*********************************************************************
+ * This will stand out clearly in your code!
+ *********************************************************************/
+if ( this_variable == that_variable )
+{
+ do_something_very_important();
+}
+
+
+/* unfortunately, this may not */
+if ( this_variable == that_variable )
+{
+ do_something_very_important();
+}
+
+
+if ( this_variable == that_variable ) /* this may not either */
+{
+ do_something_very_important();
+}
+
Exception:
Example:
-/*********************************************************************
- * This will stand out clearly in your code,
- * But the second example won't.
- *********************************************************************/
-if ( thisVariable == thatVariable )
-{
- DoSomethingVeryImportant();
-}
-
-if ( thisVariable == thatVariable ) /*can you see me?*/
-{
- DoSomethingVeryImportant(); /*not easily*/
-}
-
-
-/*********************************************************************
- * But, the encouraged exceptions:
- *********************************************************************/
-int urls_read = 0; /* # of urls read + rejected */
-int urls_rejected = 0; /* # of urls rejected */
-
-if ( 1 == X )
-{
- DoSomethingVeryImportant();
-}
-
-
-short DoSomethingVeryImportant(
- short firstparam, /* represents something */
- short nextparam /* represents something else */ )
-{
- ...code here...
-
-} /* -END- DoSomethingVeryImportant */
+/*********************************************************************
+ * This will stand out clearly in your code,
+ * But the second example won't.
+ *********************************************************************/
+if ( this_variable == this_variable )
+{
+ do_something_very_important();
+}
+
+if ( this_variable == this_variable ) /*can you see me?*/
+{
+ do_something_very_important(); /*not easily*/
+}
+
+
+/*********************************************************************
+ * But, the encouraged exceptions:
+ *********************************************************************/
+int urls_read = 0; /* # of urls read + rejected */
+int urls_rejected = 0; /* # of urls rejected */
+
+if ( 1 == X )
+{
+ do_something_very_important();
+}
+
+
+short do_something_very_important(
+ short firstparam, /* represents something */
+ short nextparam /* represents something else */ )
+{
+ ...code here...
+
+} /* -END- do_something_very_important */
+
-------------------------------------------------------------------------------
Example:
-if ( 1 == X )
-{
- DoSomethingVeryImportant();
- ...some long list of commands...
-} /* -END- if x is 1 */
-
-or:
-
-if ( 1 == X )
-{
- DoSomethingVeryImportant();
- ...some long list of commands...
-} /* -END- if ( 1 == X ) */
+if ( 1 == X )
+{
+ do_something_very_important();
+ ...some long list of commands...
+} /* -END- if x is 1 */
+
+or:
+
+if ( 1 == X )
+{
+ do_something_very_important();
+ ...some long list of commands...
+} /* -END- if ( 1 == X ) */
+
-------------------------------------------------------------------------------
Example:
-int ms_iis5_hack = 0;
+int ms_iis5_hack = 0;
+
Instead of:
-int msiis5hack = 0; int msIis5Hack = 0;
+int msiis5hack = 0; int msIis5Hack = 0;
+
-------------------------------------------------------------------------------
Example:
-int load_some_file( struct client_state *csp )
+int load_some_file( struct client_state *csp )
+
Instead of:
-int loadsomefile( struct client_state *csp )
-int loadSomeFile( struct client_state *csp )
+int loadsomefile( struct client_state *csp )
+int loadSomeFile( struct client_state *csp )
+
-------------------------------------------------------------------------------
Example:
-(.h) extern int load_aclfile( struct client_state *csp );
-(.c) int load_aclfile( struct client_state *csp )
+(.h) extern int load_aclfile( struct client_state *csp );
+(.c) int load_aclfile( struct client_state *csp )
+
Instead of:
-(.h) extern int load_aclfile( struct client_state * ); or
-(.h) extern int load_aclfile();
-(.c) int load_aclfile( struct client_state *csp )
+(.h) extern int load_aclfile( struct client_state * ); or
+(.h) extern int load_aclfile();
+(.c) int load_aclfile( struct client_state *csp )
+
-------------------------------------------------------------------------------
Example:
-(enumeration) : enum Boolean { FALSE, TRUE };
-(#define) : #define DEFAULT_SIZE 100;
+(enumeration) : enum Boolean { FALSE, TRUE };
+(#define) : #define DEFAULT_SIZE 100;
+
Note: We have a standard naming scheme for #defines that toggle a feature in
the preprocessor: FEATURE_>, where > is a short (preferably 1 or 2 word)
Example:
-#define FEATURE_FORCE 1
-
-#ifdef FEATURE_FORCE
-#define FORCE_PREFIX blah
-#endif /* def FEATURE_FORCE */
+#define FEATURE_FORCE 1
+
+#ifdef FEATURE_FORCE
+#define FORCE_PREFIX blah
+#endif /* def FEATURE_FORCE */
+
-------------------------------------------------------------------------------
Example:
-#define USE_IMAGE_LIST 1
+#define USE_IMAGE_LIST 1
+
Instead of:
-#define USE_IMG_LST 1 or
-#define _USE_IMAGE_LIST 1 or
-#define USE_IMAGE_LIST_ 1 or
-#define use_image_list 1 or
-#define UseImageList 1
+#define USE_IMG_LST 1 or
+#define _USE_IMAGE_LIST 1 or
+#define USE_IMAGE_LIST_ 1 or
+#define use_image_list 1 or
+#define UseImageList 1
+
-------------------------------------------------------------------------------
Example:
-if ( this == that )
-{
- ...
-}
+if ( this == that )
+{
+ ...
+}
+
Instead of:
Example exception:
-while ( more lines are read )
-{
- /* Please document what is/is not a comment line here */
- if ( it's a comment ) continue;
-
- do_something( line );
-}
+while ( more lines are read )
+{
+ /* Please document what is/is not a comment line here */
+ if ( it's a comment ) continue;
+
+ do_something( line );
+}
+
-------------------------------------------------------------------------------
Example:
-if ( this == that )
-{
- DoSomething();
- DoSomethingElse();
-}
+if ( this == that )
+{
+ 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
Example:
-structure->flag = ( condition );
+structure->flag = ( condition );
+
Instead of:
Example:
-int firstValue = 0;
-int someValue = 0;
-int anotherValue = 0;
-int thisVariable = 0;
-
-if ( thisVariable == thatVariable )
-
-firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
+int first_value = 0;
+int some_value = 0;
+int another_value = 0;
+int this_variable = 0;
+
+if ( this_variable == this_variable )
+
+first_value = old_value + ( ( some_value - another_value ) - whatever )
+
-------------------------------------------------------------------------------
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 ();
-------------------------------------------------------------------------------
Example:
-int function1( ... )
-{
- ...code...
- return( retCode );
-
-} /* -END- function1 */
-
-
-int function2( ... )
-{
-} /* -END- function2 */
+int function1( ... )
+{
+ ...code...
+ return( ret_code );
+
+} /* -END- function1 */
+
+
+int function2( ... )
+{
+} /* -END- function2 */
+
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
Explanation:
-If some use 8 character TABs and some use 3 character TABs, the code can look *
-very* ragged. So use 3 character indentions only. If you like to use TABs, pass
-your code through a filter such as "expand -t3" before checking in your code.
+If some use 8 character TABs and some use 3 character TABs, the code can look
+*very* ragged. So use 3 character indentions only. If you like to use TABs,
+pass your code through a filter such as "expand -t3" before checking in your
+code.
Example:
-static const char * const url_code_map[256] =
-{
- NULL, ...
-};
-
-
-int function1( ... )
-{
- if ( 1 )
- {
- return( ALWAYS_TRUE );
- }
- else
- {
- return( HOW_DID_YOU_GET_HERE );
- }
-
- return( NEVER_GETS_HERE );
-
-}
+static const char * const url_code_map[256] =
+{
+ NULL, ...
+};
+
+
+int function1( ... )
+{
+ if ( 1 )
+ {
+ return( ALWAYS_TRUE );
+ }
+ else
+ {
+ return( HOW_DID_YOU_GET_HERE );
+ }
+
+ return( NEVER_GETS_HERE );
+
+}
+
-------------------------------------------------------------------------------
Example:
-short anShort = 0;
-float aFloat = 0;
-struct *ptr = NULL;
+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.
Example:
-ShouldWeBlockThis();
-ContainsAnImage();
-IsWebPageBlank();
+should_we_block_this();
+contains_an_image();
+is_web_page_blank();
+
-------------------------------------------------------------------------------
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();
-
-for ( size_t cnt = 0; cnt < len; cnt ++ )
-{
- ....
-}
+size_t len = block_list_length();
+
+for ( size_t cnt = 0; cnt < len; cnt++ )
+{
+ ....
+}
-Exceptions: if the value of blockListLength() *may* change or could *
-potentially* change, then you must code the function call in the for/while
+
+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.
-------------------------------------------------------------------------------
Example:
-#include <iostream.h> /* This is not a local include */
-#include "config.h" /* This IS a local include */
+#include <iostream.h> /* This is not a local include */
+#include "config.h" /* This IS a local include */
+
Exception:
-/* This is not a local include, but requires a path element. */
-#include <sys/fileName.h>
+/* This is not a local include, but requires a path element. */
+#include <sys/fileName.h>
+
Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
This duplicates the #include "file.h" behavior.
Example:
-#ifndef PROJECT_H_INCLUDED
-#define PROJECT_H_INCLUDED
- ...
-#endif /* ndef PROJECT_H_INCLUDED */
+#ifndef PROJECT_H_INCLUDED
+#define PROJECT_H_INCLUDED
+ ...
+#endif /* ndef PROJECT_H_INCLUDED */
+
-------------------------------------------------------------------------------
Example:
-#ifdef __cplusplus
-extern "C"
-{
-#endif /* def __cplusplus */
-
-... function definitions here ...
-
-#ifdef __cplusplus
-}
-#endif /* def __cplusplus */
+#ifdef __cplusplus
+extern "C"
+{
+#endif /* def __cplusplus */
+
+... function definitions here ...
+
+#ifdef __cplusplus
+}
+#endif /* def __cplusplus */
+
-------------------------------------------------------------------------------
Example:
-/*********************************************************************
- * We're avoiding an include statement here!
- *********************************************************************/
-struct file_list;
-extern file_list *xyz;
+/*********************************************************************
+ * We're avoiding an include statement here!
+ *********************************************************************/
+struct file_list;
+extern file_list *xyz;
+
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,
Example:
-switch( hash_string( cmd ) )
-{
- case hash_actions_file :
- ... code ...
- break;
-
- case hash_confdir :
- ... code ...
- break;
-
- default :
- log_error( ... );
- ... anomaly code goes here ...
- continue; / break; / exit( 1 ); / etc ...
-
-} /* end switch( hash_string( cmd ) ) */
+switch( hash_string( cmd ) )
+{
+ case hash_actions_file :
+ ... code ...
+ break;
+
+ case hash_confdir :
+ ... code ...
+ break;
+
+ default :
+ log_error( ... );
+ ... anomaly code goes here ...
+ continue; / break; / exit( 1 ); / etc ...
+
+} /* end switch( hash_string( cmd ) ) */
+
Note: If you already have a default condition, you are obviously exempt from
this point. Of note, most of the WIN32 code calls `DefWindowProc' after the
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.
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.
-------------------------------------------------------------------------------
Example:
-long a = 0;
-long b = 0;
-long c = 0;
+long a = 0;
+long b = 0;
+long c = 0;
+
Instead of:
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.
Example:
-If a function creates a struct and stores a pointer to it in a
-list, then it should definitely be allocated via `malloc'.
+If a function creates a struct and stores a pointer to it in a
+list, then it should definitely be allocated via `malloc'.
+
-------------------------------------------------------------------------------
Example:
-int load_re_filterfile( struct client_state *csp ) { ... }
-static void unload_re_filterfile( void *f ) { ... }
+int load_re_filterfile( struct client_state *csp ) { ... }
+static void unload_re_filterfile( void *f ) { ... }
+
Exceptions:
-------------------------------------------------------------------------------
-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:
Example for file comments:
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 2.9 2006/09/14 02:30:07 hal9 Exp $";
-/*********************************************************************
- *
- * File : $Source$
- *
- * Purpose : (Fill me in with a good description!)
- *
- * Copyright : Written by and Copyright (C) 2001-2006 the SourceForge
- * Privoxy team. http://www.privoxy.org/
- *
- * Based on the Internet Junkbuster originally written
- * by and Copyright (C) 1997 Anonymous Coders and
- * Junkbusters Corporation. http://www.junkbusters.com
- *
- * This program 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.
- *
- * 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.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
- * USA
- *
- * Revisions :
- * $Log$
- *
- *********************************************************************/
-
-
-#include "config.h"
-
- ...necessary include files for us to do our work...
-
-const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 2.15 2008/01/19 15:03:05 hal9 Exp $";
+/*********************************************************************
+ *
+ * File : $Source$
+ *
+ * Purpose : (Fill me in with a good description!)
+ *
+ * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
+ * Privoxy team. http://www.privoxy.org/
+ *
+ * Based on the Internet Junkbuster originally written
+ * by and Copyright (C) 1997 Anonymous Coders and
+ * Junkbusters Corporation. http://www.junkbusters.com
+ *
+ * This program 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.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
+ * USA
+ *
+ * Revisions :
+ * $Log$
+ *
+ *********************************************************************/
+
+
+#include "config.h"
+
+ ...necessary include files for us to do our work...
+
+const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
+
Note: This declares the rcs variables that should be added to the
"show-proxy-args" page. If this is a brand new creation by you, you are free to
Example for file header comments:
-#ifndef _FILENAME_H
-#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.9 2006/09/14 02:30:07 hal9 Exp $"
-/*********************************************************************
- *
- * File : $Source$
- *
- * Purpose : (Fill me in with a good description!)
- *
- * Copyright : Written by and Copyright (C) 2001-2006 the SourceForge
- * Privoxy team. http://www.privoxy.org/
- *
- * Based on the Internet Junkbuster originally written
- * by and Copyright (C) 1997 Anonymous Coders and
- * Junkbusters Corporation. http://www.junkbusters.com
- *
- * This program 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.
- *
- * 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.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
- * USA
- *
- * Revisions :
- * $Log$
- *
- *********************************************************************/
-
-
-#include "project.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
- ... function headers here ...
-
-
-/* Revision control strings from this header and associated .c file */
-extern const char FILENAME_rcs[];
-extern const char FILENAME_h_rcs[];
-
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-#endif /* ndef _FILENAME_H */
-
-/*
- Local Variables:
- tab-width: 3
- end:
-*/
+#ifndef _FILENAME_H
+#define _FILENAME_H
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.15 2008/01/19 15:03:05 hal9 Exp $"
+/*********************************************************************
+ *
+ * File : $Source$
+ *
+ * Purpose : (Fill me in with a good description!)
+ *
+ * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
+ * Privoxy team. http://www.privoxy.org/
+ *
+ * Based on the Internet Junkbuster originally written
+ * by and Copyright (C) 1997 Anonymous Coders and
+ * Junkbusters Corporation. http://www.junkbusters.com
+ *
+ * This program 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.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
+ * USA
+ *
+ * Revisions :
+ * $Log$
+ *
+ *********************************************************************/
+
+
+#include "project.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+ ... function headers here ...
+
+
+/* Revision control strings from this header and associated .c file */
+extern const char FILENAME_rcs[];
+extern const char FILENAME_h_rcs[];
+
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif /* ndef _FILENAME_H */
+
+/*
+ Local Variables:
+ tab-width: 3
+ end:
+*/
+
Example for function comments:
-/*********************************************************************
- *
- * Function : FUNCTION_NAME
- *
- * Description : (Fill me in with a good description!)
- *
- * parameters :
- * 1 : param1 = pointer to an important thing
- * 2 : x = pointer to something else
- *
- * Returns : 0 => Ok, everything else is an error.
- *
- *********************************************************************/
-int FUNCTION_NAME( void *param1, const char *x )
-{
- ...
- return( 0 );
-
-}
+/*********************************************************************
+ *
+ * Function : FUNCTION_NAME
+ *
+ * Description : (Fill me in with a good description!)
+ *
+ * parameters :
+ * 1 : param1 = pointer to an important thing
+ * 2 : x = pointer to something else
+ *
+ * Returns : 0 => Ok, everything else is an error.
+ *
+ *********************************************************************/
+int FUNCTION_NAME( void *param1, const char *x )
+{
+ ...
+ return( 0 );
+
+}
+
Note: If we all follow this practice, we should be able to parse our code to
create a "self-documenting" web page.
Explain release numbers. major, minor. developer releases. etc.
1. Remove any existing rpm with rpm -e
-
+
2. Remove any file that was left over. This includes (but is not limited to)
-
+
+ /var/log/privoxy
-
+
+ /etc/privoxy
-
+
+ /usr/sbin/privoxy
-
+
+ /etc/init.d/privoxy
-
+
+ /usr/doc/privoxy*
-
+
3. Install the rpm. Any error messages?
-
+
4. start,stop,status Privoxy with the specific script (e.g. /etc/rc.d/init/
privoxy stop). Reboot your machine. Does autostart work?
-
+
5. Start browsing. Does Privoxy work? Logfile written?
-
+
6. Remove the rpm. Any error messages? All files removed?
-
+
-------------------------------------------------------------------------------
5.2. Test reports
steps:
* Select category: the distribution you test on.
-
+
* Select group: the version of Privoxy that we are about to release.
-
+
* 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).
-------------------------------------------------------------------------------
turning a development branch into stable substantially changes the
functionality, user interface or configuration syntax. Majors 1 and 2 were
Junkbuster, and 3 will be the first stable Privoxy release.
-
+
* Y, the version minor, represents the branch within the major version. At
any point in time, there are two branches being maintained: The stable
branch, with an even minor, say, 2N, in which no functionality is being
point where it can be turned into stable, the old stable branch 2N is given
up (i.e. no longer maintained), the former development branch 2N+1 becomes
the new stable branch 2N+2, and a new development branch 2N+3 is opened.
-
+
* Z, the point or sub version, represents a release of the software within a
branch. It is therefore incremented immediately before each code freeze. In
development branches, only the even point versions correspond to actual
thereafter. This ensures that builds from CVS snapshots are easily
distinguished from released versions. The point version is reset to zero
when the minor changes.
-
+
Stable branches work a little differently, since there should be little to
no development happening in such branches. Remember, only bugfixes, which
presumably should have had some testing before being committed. Stable
between releases when changes are being added. This is to denote that this
code is not for release. Then as the release nears, the version is bumped
according: e.g. 3.0.1 -> 0.0.0 -> 3.0.2.
-
+
In summary, the main CVS trunk is the development branch where new features are
being worked on for the next stable series. This should almost always be where
the most activity takes place. There is always at least one stable branch from
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
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
standalone actions file release), bump up its version info to A.B in this
line:
-
- {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
-
+
+ {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
+
+
Then change the version info in doc/webserver/actions/index.php, line:
'$required_actions_file_version = "A.B";'
-
+
* All documentation should be rebuild after the version bump. Finished docs
should be then be committed to CVS (for those without the ability to build
these). Some docs may require rather obscure processing tools. config, the
committed to CVS for other packagers. The formal docs should be uploaded to
the webserver. See the Section "Updating the webserver" in this manual for
details.
-
+
* The User Manual is also used for context sensitive help for the CGI editor.
This is version sensitive, so that the user will get appropriate help for
his/her release. So with each release a fresh version should be uploaded to
The CGI pages will link to something like http://privoxy.org/$(VERSION)/
user-manual/. This will need to be updated for each new release. There is
no Makefile target for this at this time!!! It needs to be done manually.
-
+
* All developers should look at the ChangeLog and make sure noteworthy
changes are referenced.
-
+
* Commit all files that were changed in the above steps!
-
+
* Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
-
+
* If the release was in a development branch, increase the point version from
even to odd (X.Y.(Z+1)) again in configure.in and commit your change.
-
+
* On the webserver, copy the user manual to a new top-level directory called
X.Y.Z. This ensures that help links from the CGI pages, which have the
version as a prefix, will go into the right version of the manual. If this
is a development branch release, also symlink X.Y.(Z-1) to X.Y.Z and X.Y.
(Z+1) to . (i.e. dot).
-
+
-------------------------------------------------------------------------------
6.3. Building and Releasing the Packages
that you build from clean sources by exporting the right version from CVS into
an empty directory (just press return when asked for a password):
- mkdir dist # delete or choose different name if it already exists
- cd dist
- cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
+ mkdir dist # delete or choose different name if it already exists
+ cd dist
+ cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
+
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.
* Privoxy requires write access to: all *.action files, all logfiles, and the
trust file. You will need to determine the best way to do this for your
platform.
-
+
* Please include up to date documentation. At a bare minimum:
-
+
LICENSE (top-level directory)
-
+
README (top-level directory)
-
+
AUTHORS (top-level directory)
-
+
man page (top-level directory, Unix-like platforms only)
-
+
The User Manual (doc/webserver/user-manual/)
-
+
FAQ (doc/webserver/faq/)
-
+
Also suggested: Developer Manual (doc/webserver/developer-manual) and
ChangeLog (top-level directory). FAQ and the manuals are HTML docs. There
are also text versions in doc/text/ which could conceivably also be
included.
-
+
The documentation has been designed such that the manuals are linked to
each other from parallel directories, and should be packaged that way.
privoxy-index.html can also be included and can serve as a focal point for
included for better presentation: p_doc.css. This should be in the same
directory with privoxy-index.html, (i.e. one level up from the manual
directories).
-
+
* user.action and user.filter are designed for local preferences. Make sure
these do not get overwritten! config should not be overwritten either. This
has especially important configuration data in it. trust should be left in
tact as well.
-
+
* Other configuration files (default.action, default.filter and
standard.action) should be installed as the new defaults, but all
previously installed configuration files should be preserved as backups.
This is just good manners :-) These files are likely to change between
releases and contain important new features and bug fixes.
-
+
* Please check platform specific notes in this doc, if you haven't done
"Privoxy" packaging before for other platform specific issues. Conversely,
please add any notes that you know are important for your platform (or
contact one of the doc maintainers to do this if you can't).
-
+
* Packagers should do a "clean" install of their package after building it.
So any previous installs should be removed first to ensure the integrity of
the newly built package. Then run the package for a while to make sure
there are no obvious problems, before uploading.
-
+
-------------------------------------------------------------------------------
6.3.2. Source Tarball
First, make sure that you have freshly exported the right version into an empty
directory. (See "Building and releasing packages" above). Then run:
- cd current
- autoheader && autoconf && ./configure
+ cd current
+ autoheader && autoconf && ./configure
+
Then do:
- make tarball-dist
+ make tarball-dist
+
To upload the package to Sourceforge, simply issue
- make tarball-upload
+ make tarball-upload
+
Go to the displayed URL and release the file publicly on Sourceforge. For the
change log field, use the relevant section of the ChangeLog file.
Then run:
- cd current
- autoheader && autoconf && ./configure
+ cd current
+ autoheader && autoconf && ./configure
+
Then do
- make dist-dist
+ make dist-dist
+
To upload the package to Sourceforge, simply issue
- make dist-upload rpm_packagerev
+ make dist-upload rpm_packagerev
+
where rpm_packagerev is the RPM release number as determined above. Go to the
displayed URL and release the file publicly on Sourceforge. Use the release
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
+
You will need a mix of development tools. The main compilation takes place with
IBM Visual Age C++. Some ancillary work takes place with GNU tools, available
from various sources like hobbes.nmsu.edu. Specificially, you will need
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'
+ installExeName='privoxyos2_setup_X.Y.Z.exe'
+
Next, edit the IJB.wis file so the release number matches in the PACKAGEID
section:
- PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
+ PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
+
You're now ready to build. Run:
- os2build
+ os2build
+
You will find the WarpIN-installable executable in the ./files directory.
Upload this anonymously to uploads.sourceforge.net/incoming, create a release
Login to Sourceforge's compilefarm via ssh:
- ssh cf.sourceforge.net
+ ssh cf.sourceforge.net
+
Choose the right operating system (not the Debian one). When logged in, make
sure that you have freshly exported the right version into an empty directory.
(See "Building and releasing packages" above). Then run:
- cd current
- autoheader && autoconf && ./configure
+ cd current
+ autoheader && autoconf && ./configure
+
Then run
- gmake solaris-dist
+ gmake solaris-dist
+
which creates a gzip'ed tar archive. Sadly, you cannot use make solaris-upload
on the Sourceforge machine (no ncftpput). You now have to manually upload the
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
+
Then you can build the package. This is fully automated, and is controlled by
winsetup/GNUmakefile. All you need to do is:
- cd winsetup
- make
+ cd winsetup
+ make
+
Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
upload it to SourceForge. When releasing the package on SourceForge, use the
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.5-BETA-1 "New upstream version"
+ debchange -v 3.0.8-stable-1 "New upstream version"
+
Then, run:
- dpkg-buildpackage -rfakeroot -us -uc -b
+ dpkg-buildpackage -rfakeroot -us -uc -b
+
-This will create ../privoxy_3.0.5-BETA-1_i386.deb which can be uploaded. To
+This will create ../privoxy_3.0.8-stable-1_i386.deb which can be uploaded. To
upload the package to Sourceforge, simply issue
- make debian-upload
+ make debian-upload
+
-------------------------------------------------------------------------------
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
+
Then run:
- cd osxsetup
- build
+ cd osxsetup
+ build
+
This will run autoheader, autoconf and configure as well as make. Finally, it
will copy over the necessary files to the ./osxsetup/files directory for
specify ./Privoxy.pkg as the output package name, you can then create the
distributable zip file with the command:
- zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
+ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
+
You can then upload privoxyosx_setup_x.y.z.zip anonymously to
uploads.sourceforge.net/incoming, create a release for it, and you're done. Use
Login to Sourceforge's compile-farm via ssh:
- ssh cf.sourceforge.net
+ ssh cf.sourceforge.net
+
Choose the right operating system. When logged in, make sure that you have
freshly exported the right version into an empty directory. (See "Building and
releasing packages" above). Then run:
- cd current
- autoheader && autoconf && ./configure
+ cd current
+ autoheader && autoconf && ./configure
+
Then run:
- gmake freebsd-dist
+ gmake freebsd-dist
+
which creates a gzip'ed tar archive. Sadly, you cannot use make freebsd-upload
on the Sourceforge machine (no ncftpput). You now have to manually upload the
First, make sure that you have freshly exported the right version into an empty
directory. (See "Building and releasing packages" above). Then run:
- cd current
- autoheader && autoconf && ./configure
+ cd current
+ autoheader && autoconf && ./configure
+
Then do FIXME.
First, make sure that you have freshly exported the right version into an empty
directory. (See "Building and releasing packages" above). Then run:
- cd current
- autoheader && autoconf && ./configure
+ cd current
+ autoheader && autoconf && ./configure
+
Then do FIXME.
Login to Sourceforge's compilefarm via ssh:
- ssh cf.sourceforge.net
+ ssh cf.sourceforge.net
+
Choose the right operating system. When logged in, make sure that you have
freshly exported the right version into an empty directory. (See "Building and
releasing packages" above). Then run:
- cd current
- autoheader && autoconf && ./configure
+ cd current
+ autoheader && autoconf && ./configure
+
Then run:
- make aix-dist
+ make aix-dist
+
which creates a gzip'ed tar archive. Sadly, you cannot use make aix-upload on
the Sourceforge machine (no ncftpput). You now have to manually upload the
through the release steps. The upload is done via FTP:
* Upload to: ftp://upload.sourceforge.net/incoming
-
+
* user: anonymous
-
+
* password: ijbswa-developers@lists.sourceforge.net
-
+
Or use the make targets as described above.
Once this done go to http://sourceforge.net/project/admin/editpackages.php?
group_id=11118, making sure you are logged in. Find your target platform in the
second column, and click Add Release. You will then need to create a new
release for your package, using the format of $VERSION ($CODE_STATUS), e.g.
-3.0.5 (beta).
+3.0.8 (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
make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
+
That will generate doc/webserver/user-manual, doc/webserver/developer-manual,
doc/webserver/faq, doc/pdf/*.pdf and doc/webserver/index.html automatically.
Next, commit any changes from the above steps to CVS. All set? If these are
docs in the stable branch, then do:
- make webserver
+ make webserver
+
This will do the upload to the webserver (www.privoxy.org) and ensure all files
and directories there are group writable.
8.1. Get Support
-For casual users, our support forum at SourceForge is probably best suited:
+For casual users, our support forum at SourceForge is probably best suited:
http://sourceforge.net/tracker/?group_id=11118&atid=211118
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
* 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
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. If already
submitted, please feel free to add any info to the original report that might
-help solve the issue.
+help to solve the issue.
-Please try to verify that it is a Privoxy bug, and not a browser or site bug
-first. If unsure, try toggling off Privoxy, and see if the problem persists. If
-you are using your own custom configuration, please try the stock configs to
-see if the problem is configuration related.
+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.
-If not using the latest version, the bug may have been found and fixed in the
-meantime. We would appreciate if you could take the time to upgrade to the
-latest version (or even the latest CVS snapshot) and verify your bug.
+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 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 that
+your bug still exists.
Please be sure to provide the following information:
- * The exact Privoxy version of the proxy software (if you got the source from
- CVS, please also give the date).
-
- * The operating system and versions you run Privoxy on, (e.g. Windows XP).
-
+ * 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).
+
+ * 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).
-
+
* The URL where the problem occurred, or some way for us to duplicate the
- problem (e.g. http://somesite.example.com?somethingelse=123).
-
- * Whether your version of Privoxy is one supplied by the developers of
- Privoxy via SourceForge, or somewhere else.
-
- * Whether you are using Privoxy in tandem with another proxy such as TOR. If
- so, please try disabling the other proxy.
-
+ problem (e.g. http://somesite.example.com/?somethingelse=123).
+
+ * Whether your version of Privoxy is one supplied by the Privoxy developers
+ via SourceForge, or if you got your copy somewhere else.
+
+ * 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).
-
- * Please provide your SF login, or email address, in case we need to contact
- you.
-
+
+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.
9. Privoxy Copyright, License and History
-Copyright © 2001 - 2006 by Privoxy Developers <
+Copyright 2001-2008 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.2. History
-Along time ago, there was the Internet Junkbuster, by Anonymous Coders and
+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.
http://www.privoxy.org/faq/, the Privoxy FAQ.
-http://sourceforge.net/projects/ijbswa/, the Project Page for Privoxy on
-SourceForge.
+http://sourceforge.net/projects/ijbswa/, the Project Page for Privoxy on
+SourceForge.
-http://config.privoxy.org/, the web-based user interface. Privoxy must be
-running for this to work. Shortcut: http://p.p/
+http://config.privoxy.org/, the web-based user interface. Privoxy must be
+running for this to work. Shortcut: http://p.p/
-http://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit "misses"
-and other configuration related suggestions to the developers.
+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/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://privacy.net/, a useful site to check what information about you is
-leaked while you browse the web.
+http://privacy.net/, a useful site to check what information about you is
+leaked while you browse the web.
+
+http://www.squid-cache.org/, a popular caching proxy, which is often used
+together with Privoxy.
-http://www.squid-cache.org/, a very 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://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