[ Copyright 2001-2007 by Privoxy Developers ]
-$Id: developer-manual.sgml,v 2.13 2007/10/30 17:59:31 fabiankeil Exp $
+$Id: developer-manual.sgml,v 2.14 2008/01/17 01:49:51 hal9 Exp $
The developer manual provides guidance on coding, testing, packaging,
documentation and other issues of importance to those involved with Privoxy
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.7. 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
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
ijbswa.cvs.sourceforge.net, the repository is called ijbswa, and the source
tree module is called current.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
2.2. Branches
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:
- • Please don't commit even a small change without testing it thoroughly
+ * 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.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
3. Documentation Guidelines
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
+ * 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">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.7".
+ 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").
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
is actually being done.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
4.2.2. Use blocks for comments
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
} /* -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
} /* -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
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
first_value = old_value + ( ( some_value - another_value ) - whatever )
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
4.4.5. Don't use white space around structure operators
Instead of: a_struct -> a_member; a_struct . a_member; function_name ();
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
4.4.6. Make the last brace of a function stand out
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
Status: developer-discretion if and only if the variable is assigned a value
"shortly after" declaration.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
4.6. Functions
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
*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
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
size_t against another variable of a different type (or even against a
constant) without casting one of the values.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
4.7.6. Declare each variable and struct on its own line.
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 or XXX
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.sgml,v 2.13 2007/10/30 17:59:31 fabiankeil Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 2.14 2008/01/17 01:49:51 hal9 Exp $";
/*********************************************************************
*
* File : $Source$
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.13 2007/10/30 17:59:31 fabiankeil Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.14 2008/01/17 01:49:51 hal9 Exp $"
/*********************************************************************
*
* File : $Source$
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
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! │
-└─────────────────────────────────────────────────────────────────────────────┘
++-----------------------------------------------------------------------------+
+| 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 and user.filter are designed for local preferences. Make sure
+ * 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
+ * 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
+ * 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
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
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.7-beta-1 "New upstream version"
+ debchange -v 3.0.8-stable-1 "New upstream version"
Then, run:
dpkg-buildpackage -rfakeroot -us -uc -b
-This will create ../privoxy_3.0.7-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
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
6.3.8. Mac OSX
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.7 (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
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
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
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
+ * 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
+ * "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
your feedback. These will be announced on the ijbswa-announce list and
available from our the files section of our project page.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
8.2.2. Reporting Bugs
Please be sure to provide the following information:
- • The exact Privoxy version you are using (if you got the source from CVS,
+ * 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
+ * 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.
+ * 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
+ * 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 Privoxy developers
+ * 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
+ * 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
+ * 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
+ * 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).
The appendix of the Privoxy User Manual also has helpful information on
understanding actions, and action debugging.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
8.3. Request New Features
improvement through our feature request tracker at http://sourceforge.net/
tracker/?atid=361118&group_id=11118.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
8.4. Other
mailing lists, including list archives, at: http://sourceforge.net/mail/?
group_id=11118.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
9. Privoxy Copyright, License and History
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
Boston, MA 02110-1301
USA
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
9.2. History
The result of this is Privoxy, whose first stable version, 3.0, was released
August, 2002.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
10. See also
projects / privoxy.git / blobdiff