<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
-<!entity % dummy "IGNORE">
+<!entity % dummy "IGNORE">
<!entity supported SYSTEM "supported.sgml">
<!entity newfeatures SYSTEM "newfeatures.sgml">
<!entity p-intro SYSTEM "privoxy.sgml">
Purpose : developer manual
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
-
- $Id: developer-manual.sgml,v 2.34 2010/11/06 12:55:48 fabiankeil Exp $
+
+ $Id: developer-manual.sgml,v 2.35 2011/08/17 10:40:07 fabiankeil Exp $
Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
See LICENSE.
========================================================================
- NOTE: Please read developer-manual/documentation.html before touching
+ NOTE: Please read developer-manual/documentation.html before touching
anything in this, or other Privoxy documentation. You have been warned!
- Failure to abide by this rule will result in the revocation of your license
+ Failure to abide by this rule will result in the revocation of your license
to live a peaceful existence!
========================================================================
<subscript>
<!-- Completely the wrong markup, but very little is allowed -->
<!-- in this part of an article. FIXME -->
- <link linkend="copyright">Copyright</link> &my-copy; 2001-2009 by
+ <link linkend="copyright">Copyright</link> &my-copy; 2001-2009 by
<ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
</subscript>
</pubdate>
- <pubdate>$Id: developer-manual.sgml,v 2.34 2010/11/06 12:55:48 fabiankeil Exp $</pubdate>
+ <pubdate>$Id: developer-manual.sgml,v 2.35 2011/08/17 10:40:07 fabiankeil Exp $</pubdate>
<!--
-Note: this should generate a separate page, and a live link to it.
+Note: this should generate a separate page, and a live link to it.
But it doesn't for some mysterious reason. Please leave commented
-unless it can be fixed proper. For the time being, the copyright
+unless it can be fixed proper. For the time being, the copyright
statement will be in copyright.smgl.
Hal.
-<legalnotice id="legalnotice">
+<legalnotice id="legalnotice">
<para>
text goes here ........
</para>
the state at the release of version &p-version;.
You can find the latest version of the this manual at <ulink
url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
- Please see <link linkend="contact">the Contact section</link>
+ Please see <link linkend="contact">the Contact section</link>
on how to contact the developers.
</para>
<!-- <para> -->
I don't like seeing blank space :) So added *something* here.
- -->
+ -->
<para>
<application>Privoxy</application>, as an heir to
- <application>Junkbuster</application>, is a Free Software project
+ <application>Junkbuster</application>, is a Free Software project
and the code is licensed under the GNU General Public License version 2.
As such, <application>Privoxy</application> 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 <application>Privoxy</application>, and
- to make it available to as wide an audience as possible.
+ to make it available to as wide an audience as possible.
</para>
<para>
One does not have to be a programmer to contribute. Packaging, testing,
<para>
The first step is to join the <ulink
url="mailto:ijbswa-developers@lists.sourceforge.net">developer's mailing list</ulink>.
- You can submit your ideas, or even better patches. Patches are best
- submitted to the Sourceforge tracker set up for this purpose, but
+ You can submit your ideas, or even better patches. Patches are best
+ submitted to the Sourceforge tracker set up for this purpose, but
can be sent to the list for review too.
</para>
<para>
- You will also need to have a cvs package installed, which will
+ You will also need to have a cvs package installed, which will
entail having ssh installed as well (which seems to be a requirement of
SourceForge), in order to access the cvs repository. Having the GNU build
tools is also going to be important (particularly, autoconf and gmake).
</para>
<para>
- For the time being (read, this section is under construction), you can
- also refer to the extensive comments in the source code. In fact,
+ For the time being (read, this section is under construction), you can
+ also refer to the extensive comments in the source code. In fact,
reading the code is recommended in any case.
</para>
</sect2>
<sect1 id="cvs"><title>The CVS Repository</title>
<para>
If you become part of the active development team, you will eventually
- need write access to our holy grail, the CVS repository. One of the
+ need write access to our holy grail, the CVS repository. One of the
team members will need to set this up for you. Please read
this chapter completely before accessing via CVS.
</para>
</para>
<para>
At one time there were two distinct branches: stable and unstable. The
- more drastic changes were to be in the unstable branch. These branches
- have now been merged to minimize time and effort of maintaining two
+ more drastic changes were to be in the unstable branch. These branches
+ have now been merged to minimize time and effort of maintaining two
branches.
</para>
- <!--
+ <!--
<para>
This will result in at least two active branches, which means there may
- be occasions that require the same (or similar) item to be
- checked into to two different places (assuming its a bugfix and needs
+ be occasions that require the same (or similar) item to be
+ checked into to two different places (assuming its a bugfix and needs
fixing in both the stable and unstable trees). This also means that in
- order to have access to both trees, both will have to be checked out
- separately. Use the <literal>cvs -r</literal> flag to check out a
+ order to have access to both trees, both will have to be checked out
+ separately. Use the <literal>cvs -r</literal> flag to check out a
branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
</para>
- -->
+ -->
</sect2>
<sect2 id="cvscommit"><title>CVS Commit Guidelines</title>
main development trunk, and we ask anyone with CVS access to strictly
adhere to the following guidelines:
</para>
-
+
<para>
Basic Guidelines, for all branches:
</para>
<para>
<itemizedlist>
<listitem><para>
- Please don't commit even
+ 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
+ close to a public release, ask a fellow developer to review your
changes.
</para></listitem>
<listitem><para>
url="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
tracker</ulink> instead.
</para>
- </listitem>
+ </listitem>
</itemizedlist>
</para>
-
+
<!--
<para>
- Stable branches are handled with more care, especially after the
- initial *.*.0 release, and we are just in bugfix mode. In addition to
- the above, the below applies only to the stable branch (currently the
+ Stable branches are handled with more care, especially after the
+ initial *.*.0 release, and we are just in bugfix mode. In addition to
+ the above, the below applies only to the stable branch (currently the
<literal>v_3_0_branch</literal> branch):
</para>
-
+
<para>
<itemizedlist>
<listitem>
project, or have prior approval of the project leaders or consensus
of the devel list.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- Where possible, bugfixes and changes should be tested in the main
- development trunk first. There may be occasions where this is not
+ Where possible, bugfixes and changes should be tested in the main
+ development trunk first. There may be occasions where this is not
feasible, though.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- Alternately, proposed changes can be submitted as patches to the patch tracker on
+ Alternately, proposed changes can be submitted as patches to the patch tracker on
Sourceforge first: <ulink
url="http://sourceforge.net/tracker/?group_id=11118&atid=311118">http://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
- Then ask for peer review.
+ Then ask for peer review.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Do not even think about anything except bugfixes. No new features!
</para>
- </listitem>
-
+ </listitem>
+
</itemizedlist>
- </para>
+ </para>
-->
</sect2>
</sect1>
-
+
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="documentation"><title>Documentation Guidelines</title>
<para>
All formal documents are maintained in Docbook SGML and located in the
<computeroutput>doc/source/*</computeroutput> directory. You will need
- <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
+ <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
DTD's and the Docbook modular stylesheets (or comparable alternatives),
and either <application>jade</application> or
<application>openjade</application> (recommended) installed in order to
<citetitle>privoxy.1</citetitle> (man page), and
<citetitle>config</citetitle> files are also now maintained as Docbook
SGML. These files, when built, in the top-level source directory are
- generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
- variation on this file, <filename>privoxy-index.html</filename>,
+ generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
+ variation on this file, <filename>privoxy-index.html</filename>,
meant for inclusion with doc packages), are maintained as SGML as well.
<emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
contact someone involved in the documentation.
- </para>
+ </para>
<para>
<filename>config</filename> requires some special handling. The reason it
is maintained this way is so that the extensive comments in the file
- mirror those in <citetitle>user-manual</citetitle>. But the conversion
- process requires going from SGML to HTML to text to special formatting
+ mirror those in <citetitle>user-manual</citetitle>. But the conversion
+ process requires going from SGML to HTML to text to special formatting
required for the embedded comments. Some of this does not survive so
well. Especially some of the examples that are longer than 80 characters.
- The build process for this file outputs to <filename>config.new</filename>,
+ The build process for this file outputs to <filename>config.new</filename>,
which should be reviewed for errors and mis-formatting. Once satisfied
that it is correct, then it should be hand copied to
<filename>config</filename>.
<para>
Packagers are encouraged to include this documentation. For those without
the ability to build the docs locally, text versions of each are kept in
- CVS. HTML versions are also being kept in CVS under
- <filename>doc/webserver/*</filename>. And PDF version are kept in
+ CVS. HTML versions are also being kept in CVS under
+ <filename>doc/webserver/*</filename>. And PDF version are kept in
<filename>doc/pdf/*</filename>.
</para>
<para>
</para>
<para>
How do you update the webserver (i.e. the pages on privoxy.org)?
-
+
<orderedlist numeration="arabic">
<listitem><para>
First, build the docs by running <computeroutput>make
<para>
Finished docs should be occasionally submitted to CVS
- (<filename>doc/webserver/*/*.html</filename>) so that those without
+ (<filename>doc/webserver/*/*.html</filename>) so that those without
the ability to build them locally, have access to them if needed.
This is especially important just prior to a new release! Please
do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
<sect2 id="sgml">
<title>Quickstart to Docbook and SGML</title>
<para>
- If you are not familiar with SGML, it is a markup language similar to HTML.
- Actually, not a mark up language per se, but a language used to define
+ If you are not familiar with SGML, it is a markup language similar to HTML.
+ Actually, not a mark up language per se, but a language used to define
markup languages. In fact, HTML is an SGML application. Both will use
<quote>tags</quote> to format text and other content. SGML tags can be much
more varied, and flexible, but do much of the same kinds of things. The tags,
or <quote>elements</quote>, are definable in SGML. There is no set
<quote>standards</quote>. Since we are using
- <application>Docbook</application>, our tags are those that are defined by
+ <application>Docbook</application>, our tags are those that are defined by
<application>Docbook</application>. Much of how the finish document is
rendered is determined by the <quote>stylesheets</quote>.
The stylesheets determine how each tag gets translated to HTML, or other
<para>
Our documents use <quote>sections</quote> for the most part. Sections
- will be processed into HTML headers (e.g. <literal>h1</literal> for
+ will be processed into HTML headers (e.g. <literal>h1</literal> for
<literal>sect1</literal>). The <application>Docbook</application> stylesheets
- will use these to also generate the Table of Contents for each doc. Our
- TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
- <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
- entries, but <literal>sect4</literal> will not. Each section requires
- a <literal><title></literal> element, and at least one
- <literal><para></literal>. There is a limit of five section
- levels in Docbook, but generally three should be sufficient for our
+ will use these to also generate the Table of Contents for each doc. Our
+ TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
+ <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
+ entries, but <literal>sect4</literal> will not. Each section requires
+ a <literal><title></literal> element, and at least one
+ <literal><para></literal>. There is a limit of five section
+ levels in Docbook, but generally three should be sufficient for our
purposes.
</para>
<para>
- Some common elements that you likely will use:
+ Some common elements that you likely will use:
</para>
<para>
<simplelist>
<member>
- <emphasis><para></para></emphasis>, paragraph delimiter. Most
+ <emphasis><para></para></emphasis>, paragraph delimiter. Most
text needs to be within paragraph elements (there are some exceptions).
</member>
<member>
<emphasis><command></command></emphasis>, command examples.
</member>
<member>
- <emphasis><literallayout></literallayout></emphasis>, like
+ <emphasis><literallayout></literallayout></emphasis>, like
<literal><pre></literal>, more or less.
</member>
<member>
<emphasis><listitem></listitem></emphasis>, member of the above.
</member>
<member>
- <emphasis><screen></screen></emphasis>, screen output, implies
+ <emphasis><screen></screen></emphasis>, screen output, implies
<literal><literallayout></literal>.
</member>
<member>
- <emphasis><ulink url="example.com"></ulink></emphasis>, like
+ <emphasis><ulink url="example.com"></ulink></emphasis>, like
HTML <literal><a></literal> tag.
</member>
<member>
- <emphasis><quote></quote></emphasis>, for, doh, quoting text.
+ <emphasis><quote></quote></emphasis>, for, doh, quoting text.
</member>
</simplelist>
</para>
<sect2 id="docstyle">
<title><application>Privoxy</application> Documentation Style</title>
<para>
- It will be easier if everyone follows a similar writing style. This
- just makes it easier to read what someone else has written if it
+ It will be easier if everyone follows a similar writing style. This
+ just makes it easier to read what someone else has written if it
is all done in a similar fashion.
</para>
<para>
<para>
All tags should be lower case.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Tags delimiting a <emphasis>block</emphasis> of text (even small
Just to <emphasis>emphasize</emphasis>, some text goes here.
</literallayout>
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Tags should be nested and step indented for block text like: (except
- in-line tags)
+ in-line tags)
<literallayout>
<para>
<itemizedlist>
</literallayout>
This makes it easier to find the text amongst the tags ;-)
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- Use white space to separate logical divisions within a document,
- like between sections. Running everything together consistently
+ 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.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- 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
+ 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>.)
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- We have an international audience. Refrain from slang, or English
- idiosyncrasies (too many to list :). Humor also does not translate
+ We have an international audience. Refrain from slang, or English
+ idiosyncrasies (too many to list :). Humor also does not translate
well sometimes.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
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.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- 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
+ 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:
</para>
<para>
My favorite site is <ulink url="http://example.com">here</ulink>.
</para>
<para>
- This will render as <quote>My favorite site is here</quote>, which is
+ This will render as <quote>My favorite site is here</quote>, which is
not real helpful in a text doc. Better like this:
</para>
<para>
<literal>-H</literal> option. (<application>ispell</application> I think
too.)
</para>
- </listitem>
+ </listitem>
</itemizedlist>
- </para>
-
+ </para>
+
</sect2>
-
+
<!-- ~~~~~ New section ~~~~~ -->
<sect2><title>Privoxy Custom Entities</title>
<para>
- <application>Privoxy</application> documentation is using
- a number of customized <quote>entities</quote> to facilitate
- documentation maintenance.
+ <application>Privoxy</application> documentation is using
+ a number of customized <quote>entities</quote> to facilitate
+ documentation maintenance.
</para>
<para>
We are using a set of <quote>boilerplate</quote> files with generic text,
that is used by multiple docs. This way we can write something once, and use
it repeatedly without having to re-write the same content over and over again.
If editing such a file, keep in mind that it should be
- <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
+ <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
contexts without additional modifications.
</para>
<para>
- We are also using what <application>Docbook</application> calls
- <quote>internal entities</quote>. These are like variables in
+ We are also using what <application>Docbook</application> calls
+ <quote>internal entities</quote>. These are like variables in
programming. Well, sort of. For instance, we have the
- <literal>p-version</literal> entity that contains the current
- <application>Privoxy</application> version string. You are strongly
- encouraged to use these where possible. Some of these obviously
+ <literal>p-version</literal> entity that contains the current
+ <application>Privoxy</application> version string. You are strongly
+ encouraged to use these where possible. Some of these obviously
require re-setting with each release (done by the Makefile). A sampling of
custom entities are listed below. See any of the main docs for examples.
</para>
</para>
<para>
In this example, the contents of the file,
- <filename>supported.sgml</filename> is available for inclusion anywhere
- in the doc. To make this happen, just reference the now defined
- entity: <literal>&supported;</literal> (starts with an ampersand
- and ends with a semi-colon), and the contents will be dumped into
+ <filename>supported.sgml</filename> is available for inclusion anywhere
+ in the doc. To make this happen, just reference the now defined
+ entity: <literal>&supported;</literal> (starts with an ampersand
+ and ends with a semi-colon), and the contents will be dumped into
the finished doc at that point.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Commonly used <quote>internal entities</quote>:
</para>
<simplelist>
<member>
- <emphasis>p-version</emphasis>: the <application>Privoxy</application>
+ <emphasis>p-version</emphasis>: the <application>Privoxy</application>
version string, e.g. <quote>&p-version;</quote>.
</member>
<member>
- <emphasis>p-status</emphasis>: the project status, either
+ <emphasis>p-status</emphasis>: the project status, either
<quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
</member>
<member>
- <emphasis>p-not-stable</emphasis>: use to conditionally include
+ <emphasis>p-not-stable</emphasis>: use to conditionally include
text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
</member>
<member>
<emphasis>p-text</emphasis>: this doc is only generated as text.
</member>
</simplelist>
- </listitem>
+ </listitem>
</itemizedlist>
- </para>
+ </para>
<para>
- There are others in various places that are defined for a specific
+ There are others in various places that are defined for a specific
purpose. Read the source!
</para>
-
+
</sect2>
-
+
</sect1>
<!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
</sect2>
<sect2 id="s2"><title>Using Comments</title>
-
+
<sect3 id="s3"><title>Comment, Comment, Comment</title>
</programlisting>
</sect3>
-
+
<sect3 id="s4"><title>Use blocks for comments</title>
wish to "disrupt" the flow of the code, feel free to use a 1
line comment which is NOT on the same line as the code.</para>
-
+
</sect3>
-
+
<sect3 id="s5"><title>Keep Comments on their own line</title>
} /* -END- do_something_very_important */
</programlisting>
</sect3>
-
+
<sect3 id="s6"><title>Comment each logical step</title>
comment. After all, these are usually major logic
containers.</para>
-
+
</sect3>
-
+
<sect3 id="s7"><title>Comment All Functions Thoroughly</title>
functions should contain the information presented in the
addendum section of this document.</para>
-
+
</sect3>
-
+
<sect3 id="s8"><title>Comment at the end of braces if the
content is more than one screen length</title>
} /* -END- if ( 1 == X ) */
</programlisting>
</sect3>
-
+
</sect2>
<sect2 id="s9"><title>Naming Conventions</title>
-
+
<sect3 id="s10"><title>Variable Names</title>
</programlisting>
</para>
-
- </sect3>
+
+ </sect3>
<sect3 id="s11"><title>Function Names</title>
</programlisting>
</para>
-
+
</sect3>
-
+
<sect3 id="s12"><title>Header file prototypes</title>
<para><emphasis>Instead of:</emphasis>
<programlisting>
-(.h) extern int load_aclfile( struct client_state * ); or
-(.h) extern int load_aclfile();
+(.h) extern int load_aclfile( struct client_state * ); or
+(.h) extern int load_aclfile();
(.c) int load_aclfile( struct client_state *csp )
</programlisting>
</para>
-
+
</sect3>
-
+
<sect3 id="s13"><title>Enumerations, and #defines</title>
#endif /* def FEATURE_FORCE */
</programlisting>
</sect3>
-
+
<sect3 id="s14"><title>Constants</title>
<para>
<programlisting>
-#define USE_IMG_LST 1 or
+#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 use_image_list 1 or
#define UseImageList 1
</programlisting>
</para>
-
+
</sect3>
</sect2>
-
+
<sect2 id="s15"><title>Using Space</title>
-
+
<sect3 id="s16"><title>Put braces on a line by themselves.</title>
}
</programlisting>
</sect3>
-
+
<sect3 id="s17"><title>ALL control statements should have a
block</title>
"feature". The "explanation" and "exception" from the point
above also applies.</para>
-
+
</sect3>
-
+
<sect3 id="s18"><title>Do not belabor/blow-up boolean
expressions</title>
to the project has at least a "good" knowledge of C/C++. (Hope
I do not offend by that last comment ... 8-)</para>
-
+
</sect3>
-
+
<sect3 id="s19"><title>Use white space freely because it is
free</title>
first_value = old_value + ( ( some_value - another_value ) - whatever )
</programlisting>
</sect3>
-
+
<sect3 id="s20"><title>Don't use white space around structure
operators</title>
<para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
function_name ();</para>
-
+
</sect3>
-
+
<sect3 id="s21"><title>Make the last brace of a function stand
out</title>
<para><emphasis>Status:</emphasis> developer-discretion on the number of blank
lines. Enforced is the end of function comments.</para>
-
+
</sect3>
-
+
<sect3 id="s22"><title>Use 3 character indentions</title>
</sect3>
</sect2>
-
+
<sect2 id="s23"><title>Initializing</title>
-
+
<sect3 id="s24"><title>Initialize all variables</title>
</sect3>
</sect2>
-
+
<sect2 id="s25"><title>Functions</title>
-
+
<sect3 id="s26"><title>Name functions that return a boolean as a
question.</title>
is_web_page_blank();
</programlisting>
</sect3>
-
+
<sect3 id="s27"><title>Always specify a return type for a
function.</title>
purpose, and create a void return type if the function does not
need to return anything.</para>
-
+
</sect3>
-
+
<sect3 id="s28"><title>Minimize function calls when iterating by
using variables</title>
*may* change or could *potentially* change, then you must code the
function call in the for/while loop.</para>
-
+
</sect3>
-
+
<sect3 id="s29"><title>Pass and Return by Const Reference</title>
<para>Both these pointers are *const*! If the c runtime library
maintainers do it, we should too.</para>
-
+
</sect3>
-
+
<sect3 id="s30"><title>Pass and Return by Value</title>
prototypes with "pass by value": int load_aclfile( struct
client_state *csp )</para>
-
+
</sect3>
-
+
<sect3 id="s31"><title>Names of include files</title>
<para>
<programlisting>
-/* This is not a local include, but requires a path element. */
+/* This is not a local include, but requires a path element. */
#include <sys/fileName.h>
</programlisting>
</para>
without a _very_ good reason. This duplicates the #include
"file.h" behavior.</para>
-
+
</sect3>
-
+
<sect3 id="s32"><title>Provide multiple inclusion
protection</title>
#endif /* ndef PROJECT_H_INCLUDED */
</programlisting>
</sect3>
-
+
<sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
#endif /* def __cplusplus */
</programlisting>
</sect3>
-
+
<sect3 id="s34"><title>Where Possible, Use Forward Struct
Declaration Instead of Includes</title>
<para><emphasis>Status:</emphasis> Use with discretion.</para>
-
+
</sect3>
</sect2>
<sect2 id="s35"><title>General Coding Practices</title>
-
+
<sect3 id="s36"><title>Turn on warnings</title>
should turn on as many as possible. With GCC, the switch is
"-Wall". Try and fix as many warnings as possible.</para>
-
+
</sect3>
-
+
<sect3 id="s37"><title>Provide a default case for all switch
statements</title>
<para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
-
+
</sect3>
-
+
<sect3 id="s38"><title>Try to avoid falling through cases in a
switch statement.</title>
the fact of the fall through and reason why you felt it was
necessary.</para>
-
+
</sect3>
-
+
<sect3 id="s39"><title>Use 'long' or 'short' Instead of
'int'</title>
now). Should we add these to IJB now that we have a "configure"
script?</para>
-
+
</sect3>
-
+
<sect3 id="s40"><title>Don't mix size_t and other types</title>
variable of a different type (or even against a constant)
without casting one of the values.</para>
-
+
</sect3>
-
+
<sect3 id="s41"><title>Declare each variable and struct on its
own line.</title>
<para><emphasis>Status:</emphasis> developer-discretion.</para>
-
+
</sect3>
-
+
<sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
list, then it should definitely be allocated via `malloc'.
</programlisting>
</sect3>
-
+
<sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
Responsible for Ensuring 'free'</title>
standard is for allocating and freeing data structures (complex
or nested).</para>
-
+
</sect3>
-
+
<sect3 id="s44"><title>Add loaders to the `file_list' structure
and in order</title>
POPUPs can also be referred to as KILLPOPUPs, it is clear that
it should come first.</para>
-
+
</sect3>
-
+
<sect3 id="s45"><title>"Uncertain" new code and/or changes to
existing code, use FIXME or XXX</title>
include in the project (or conversely exclude from the
project).</para>
-
+
</sect3>
</sect2>
* The GNU General Public License should be included with
* this file. If not, you can view it at
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
- * or write to the Free Software Foundation, Inc.,
+ * or write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
* USA
*
* The GNU General Public License should be included with
* this file. If not, you can view it at
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
- * or write to the Free Software Foundation, Inc.,
+ * or write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
* USA
*
Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
at sourceforge. Three simple steps:
<itemizedlist>
-
+
<listitem><para>Select category: the distribution you test on.</para></listitem>
<listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
<listitem><para>Fill the Summary and Detailed Description with something
Do not mail to the mailing list (we cannot keep track on issues there).
</para>
</sect2>
-
+
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
<title>Version numbers</title>
<para>
- First you need to determine which version number the release will have.
+ First you need to determine which version number the release will have.
<application>Privoxy</application> version numbers consist of three numbers,
separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
<itemizedlist>
<para>
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
+ user interface or configuration syntax. Majors 1 and 2 were
<application>Junkbuster</application>, and 3 will be the first stable
<application>Privoxy</application> release.
</para>
<listitem>
<para>
Z, the point or sub version, represents a release of the software within a branch.
- It is therefore incremented immediately before each code freeze.
+ It is therefore incremented immediately before each code freeze.
In development branches, only the even point versions correspond to actual releases,
while the odd ones denote the evolving state of the sources on CVS in between.
It follows that Z is odd on CVS in development branches most of the time. There, it gets
Stable branches work a little differently, since there should be
little to no development happening in such branches. Remember,
only bugfixes, which presumably should have had some testing
- before being committed. Stable branches will then have their
- version reported as <literal>0.0.0</literal>, during that period
- between releases when changes are being added. This is to denote
- that this code is <emphasis>not for release</emphasis>. Then
- as the release nears, the version is bumped according: e.g.
+ before being committed. Stable branches will then have their
+ version reported as <literal>0.0.0</literal>, during that period
+ between releases when changes are being added. This is to denote
+ that this code is <emphasis>not for release</emphasis>. Then
+ as the release nears, the version is bumped according: e.g.
<literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
</para>
</listitem>
<emphasis>before</emphasis> committing to a stable branch!
</para>
<para>
- Developers should remember too that if they commit a bugfix to the stable
- branch, this will more than likely require a separate submission to the
- main trunk, since these are separate development trees within CVS. If you
+ Developers should remember too that if they commit a bugfix to the stable
+ branch, this will more than likely require a separate submission to the
+ main trunk, since these are separate development trees within CVS. If you
are working on both, then this would require at least two separate check
outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
which is <literal>v_3_0_branch</literal> at the moment).
</para>
</sect2>
-
+
<sect2 id="beforerelease">
<title>Before the Release: Freeze</title>
<para>
they have pending changes/fixes in their pipelines. Announce the
freeze so that nobody will interfere with last minute changes.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Increment the version number (point from odd to even in development
- branches!) in <filename>configure.in</filename>. (RPM spec files
+ branches!) in <filename>configure.in</filename>. (RPM spec files
will need to be incremented as well.)
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
If <filename>default.action</filename> 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:
</para>
- <para>
+ <para>
<programlisting>
{+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
</programlisting>
</para>
- <para>
+ <para>
Then change the version info in doc/webserver/actions/index.php,
line: '$required_actions_file_version = "A.B";'
</para>
<listitem>
<para>
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
+ 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. <filename>config</filename>,
the man page (and the html version of the man page), and the PDF docs
fall in this category. REAMDE, the man page, AUTHORS, and config
- should all also be committed to CVS for other packagers. The
+ should all also be committed to CVS for other packagers. The
formal docs should be uploaded to the webserver. See the
Section "Updating the webserver" in this manual for details.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- The <citetitle>User Manual</citetitle> is also used for context
+ The <citetitle>User Manual</citetitle> 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
+ 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 <citetitle>User Manual</citetitle>
- link from the main page since we need to keep manuals for various
- versions available). The CGI pages will link to something like
+ link from the main page since we need to keep manuals for various
+ versions available). The CGI pages will link to something like
<literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. 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.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
All developers should look at the <filename>ChangeLog</filename> and
make sure noteworthy changes are referenced.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
<emphasis>Commit all files that were changed in the above steps!</emphasis>
<quote><command>cvs tag v_X_Y_Z</command></quote>.
Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
If the release was in a development branch, increase the point version
from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
commit your change.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
On the webserver, copy the user manual to a new top-level directory
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 <filename>X.Y.(Z-1)</filename>
to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
- <filename>.</filename> (i.e. dot).
+ <filename>.</filename> (i.e. dot).
</para>
- </listitem>
+ </listitem>
</itemizedlist>
- </para>
+ </para>
</sect2>
-
+
<sect2 id="therelease">
<title>Building and Releasing the Packages</title>
<para>
Now the individual packages can be built and released. Note that for
GPL reasons the first package to be released is always the source tarball.
</para>
-
+
<para>
For <emphasis>all</emphasis> types of packages, including the source tarball,
<emphasis>you must make sure that you build from clean sources by exporting
the right version from CVS into an empty directory</emphasis> (just press return when
asked for a password):
</para>
-
+
<para>
<programlisting>
mkdir dist # delete or choose different name if it already exists
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
</programlisting>
</para>
-
+
<para>
<emphasis>Do NOT change</emphasis> 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.
</para>
-
+
<warning>
<para>
- 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
+ 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!
</para>
<para>
Please find additional instructions for the source tarball and the
- individual platform dependent binary packages below. And details
+ individual platform dependent binary packages below. And details
on the Sourceforge release process below that.
</para>
<sect3 id="pack-guidelines">
<title>Note on Privoxy Packaging</title>
<para>
- Please keep these general guidelines in mind when putting together
+ Please keep these general guidelines in mind when putting together
your package. These apply to <emphasis>all</emphasis> platforms!
</para>
<para>
<listitem>
<para>
<application>Privoxy</application> <emphasis>requires</emphasis>
- write access to: all <filename>*.action</filename> files, all
- logfiles, and the <filename>trust</filename> file. You will
+ write access to: all <filename>*.action</filename> files, all
+ logfiles, and the <filename>trust</filename> file. You will
need to determine the best way to do this for your platform.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Please include up to date documentation. At a bare minimum:
</para>
<para>
The documentation has been designed such that the manuals are linked
- to each other from parallel directories, and should be packaged
+ to each other from parallel directories, and should be packaged
that way. <filename>privoxy-index.html</filename> can also be
included and can serve as a focal point for docs and other links of
interest (and possibly renamed to <filename>index.html</filename>).
- This should be one level up from the manuals. There is a link also
+ This should be one level up from the manuals. There is a link also
on this page to an HTMLized version of the man page. To avoid 404 for
this, it is in CVS as
<filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
with <filename>privoxy-index.html</filename>, (i.e. one level up from
the manual directories).
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
<filename>user.action</filename> and <filename>user.filter</filename>
are designed for local preferences. Make sure these do not get overwritten!
- <filename>config</filename> should not be overwritten either. This
+ <filename>config</filename> should not be overwritten either. This
has especially important configuration data in it.
<filename>trust</filename> should be left in tact as well.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
Other configuration files (<filename>default.action</filename> and
likely to change between releases and contain important new features
and bug fixes.
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- Please check platform specific notes in this doc, if you haven't
- done <quote>Privoxy</quote> 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
+ Please check platform specific notes in this doc, if you haven't
+ done <quote>Privoxy</quote> 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).
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
- Packagers should do a <quote>clean</quote> 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
+ Packagers should do a <quote>clean</quote> 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.
</para>
- </listitem>
+ </listitem>
</itemizedlist>
- </para>
-
+ </para>
+
</sect3>
<sect3 id="newrelease-tarball"><title>Source Tarball</title>
<para>
First, <emphasis>make sure that you have freshly exported the right
version into an empty directory</emphasis>. (See "Building and releasing
- packages" above).
+ packages" above).
</para>
<para>
As the only exception to not changing anything after export from CVS,
<para>
Change directory to the <filename>os2setup</filename> directory.
Edit the os2build.cmd file to set the final executable filename.
- For example,
+ For example,
</para>
<para>
<programlisting>
</programlisting>
</para>
<para>
- Then, run:
+ Then, run:
</para>
<para>
<programlisting>
</programlisting>
</para>
<para>
- You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to
+ You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to
<filename>uploads.sourceforge.net/incoming</filename>,
create a release for it, and you're done. Use the release notes
and Change Log from the source tarball package.
<sect2 id="releasing">
<title>Uploading and Releasing Your Package</title>
<para>
- After the package is ready, it is time to upload it
+ 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:
</para>
<para>
Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
user: <literal>anonymous</literal>
</para>
- </listitem>
+ </listitem>
<listitem>
<para>
password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
</para>
- </listitem>
+ </listitem>
</itemizedlist>
- </para>
+ </para>
<para>
Or use the <command>make</command> targets as described above.
</para>
<para>
Once this done go to <ulink
url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
- >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
- making sure you are logged in. Find your target platform in the
- second column, and click <literal>Add Release</literal>. You will
- then need to create a new release for your package, using the format
+ >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
+ making sure you are logged in. Find your target platform in the
+ second column, and click <literal>Add Release</literal>. You will
+ then need to create a new release for your package, using the format
of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
(beta)</emphasis>.
</para>
<para>
Now just follow the prompts. Be sure to add any appropriate Release
- notes. You should see your freshly uploaded packages in
- <quote>Step 2. Add Files To This Release</quote>. Check the
- appropriate box(es). Remember at each step to hit the
- <quote>Refresh/Submit</quote> buttons! You should now see your
- file(s) listed in Step 3. Fill out the forms with the appropriate
+ notes. You should see your freshly uploaded packages in
+ <quote>Step 2. Add Files To This Release</quote>. Check the
+ appropriate box(es). Remember at each step to hit the
+ <quote>Refresh/Submit</quote> buttons! You should now see your
+ file(s) listed in Step 3. Fill out the forms with the appropriate
information for your platform, being sure to hit <quote>Update</quote>
- for each file. If anyone is monitoring your platform, check the
- <quote>email</quote> box at the very bottom to notify them of
+ for each file. If anyone is monitoring your platform, check the
+ <quote>email</quote> box at the very bottom to notify them of
the new package. This should do it!
</para>
<para>
- If you have made errors, or need to make changes, you can go through
- essentially the same steps, but select <literal>Edit Release</literal>,
+ If you have made errors, or need to make changes, you can go through
+ essentially the same steps, but select <literal>Edit Release</literal>,
instead of <literal>Add Release</literal>.
</para>
</sect2>
include the
<ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
location</ulink>, the release notes and the Changelog. Also, post an
- updated News item on the project page Sourceforge, and update the Home
+ updated News item on the project page Sourceforge, and update the Home
page and docs linked from the Home page (see below). Other news sites
and release oriented sites, such as Freshmeat, should also be notified.
</para>
</sect2>
</sect1>
-
+
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="webserver-update"><title>Update the Webserver</title>
<para>
The webserver should be updated at least with each stable release. When
updating, please follow these steps to make sure that no broken links,
- inconsistent contents or permission problems will occur (as it has many
+ inconsistent contents or permission problems will occur (as it has many
times in the past!):
</para>
<para>
<para>
That will generate <filename>doc/webserver/user-manual</filename>,
<filename>doc/webserver/developer-manual</filename>,
- <filename>doc/webserver/faq</filename>,
+ <filename>doc/webserver/faq</filename>,
<filename>doc/pdf/*.pdf</filename> and
<filename>doc/webserver/index.html</filename> automatically.
</para>
create new directories under <filename>doc/webserver</filename>).
</para>
<para>
- Next, commit any changes from the above steps to CVS. All set?
+ Next, commit any changes from the above steps to CVS. All set?
If these are docs in the stable branch, then do:
</para>
<para>
&contacting;
<!-- end contacting -->
</sect1>
-
+
<!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
<sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
</sect2>
</sect1>
-
+
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="seealso"><title>See also</title>
<!-- Include seealso.sgml -->
<!--
- This program is free software; you can redistribute it
+ 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
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: developer-manual.sgml,v $
+ Revision 2.35 2011/08/17 10:40:07 fabiankeil
+ Update the entities.
+
+ This commit is chronological out of order.
+
Revision 2.34 2010/11/06 12:55:48 fabiankeil
Set p-version to 3.0.17
projects / privoxy.git / blobdiff