1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
2 <!entity % dummy "IGNORE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity history SYSTEM "history.sgml">
7 <!entity seealso SYSTEM "seealso.sgml">
8 <!entity p-version "3.0.30">
9 <!entity p-status "UNRELEASED">
10 <!entity % p-not-stable "INCLUDE">
11 <!entity % p-stable "IGNORE">
12 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
13 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
14 <!entity % seealso-extra "INCLUDE"> <!-- extra stuff from seealso.sgml -->
15 <!entity my-copy "©"> <!-- kludge for docbook2man -->
18 File : doc/source/developer-manual.sgml
20 Purpose : developer manual
22 Copyright (C) 2001-2020 Privoxy Developers https://www.privoxy.org/
25 ========================================================================
26 NOTE: Please read developer-manual/documentation.html before touching
27 anything in this, or other Privoxy documentation. You have been warned!
28 Failure to abide by this rule will result in the revocation of your license
29 to live a peaceful existence!
30 ========================================================================
36 <title>Privoxy Developer Manual</title>
39 <!-- Completely the wrong markup, but very little is allowed -->
40 <!-- in this part of an article. FIXME -->
41 <ulink url="https://www.privoxy.org/user-manual/copyright.html">Copyright</ulink>
42 &my-copy; 2001-2020 by
43 <ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
49 Note: this should generate a separate page, and a live link to it.
50 But it doesn't for some mysterious reason. Please leave commented
51 unless it can be fixed proper. For the time being, the copyright
52 statement will be in copyright.smgl.
56 <legalnotice id="legalnotice">
58 text goes here ........
69 This is here to keep vim syntax file from breaking :/
70 If I knew enough to fix it, I would.
71 PLEASE DO NOT REMOVE! HB: hal@foobox.net
76 The developer manual provides guidance on coding, testing, packaging, documentation
77 and other issues of importance to those involved with
78 <application>Privoxy</application> development. It is mandatory (and helpful!) reading
79 for anyone who wants to join the team. Note that it's currently out of date
80 and may not be entirely correct. As always, patches are welcome.
83 <!-- Include privoxy.sgml boilerplate text: -->
85 <!-- &p-intro; Someone interested enough in the project to contribute
86 will already know at this point what Privoxy is. -->
88 <!-- end boilerplate -->
91 Please note that this document is constantly evolving. This copy represents
92 the state at the release of version &p-version;.
93 You can find the latest version of the this manual at <ulink
94 url="https://www.privoxy.org/developer-manual/">https://www.privoxy.org/developer-manual/</ulink>.
95 Please have a look at the
96 <ulink url="https://www.privoxy.org/user-manual/contact.html">contact section in the user manual</ulink>
97 if you are interested in contacting the developers.
104 <!-- ~~~~~ New section ~~~~~ -->
105 <sect1 id="introduction"><title>Introduction</title>
108 I don't like seeing blank space :) So added *something* here.
112 <application>Privoxy</application>, as an heir to
113 <application>Junkbuster</application>, is a <ulink
114 url="https://www.privoxy.org/user-manual/copyright.html">Free Software</ulink> project.
115 As such, <application>Privoxy</application> development is potentially open
116 to anyone who has the time, knowledge, and desire to contribute
117 in any capacity. Our goals are simply to continue the mission,
118 to improve <application>Privoxy</application>, and
119 to make it available to as wide an audience as possible.
122 One does not have to be a programmer to contribute. Packaging, testing,
123 documenting and porting, are all important jobs as well.
126 <!-- ~~~~~ New section ~~~~~ -->
127 <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
129 The first step is to join the <ulink
130 url="https://lists.privoxy.org/mailman/listinfo/privoxy-devel">privoxy-devel mailing list</ulink>.
131 You can submit your ideas or, even better, patches.
132 Patches can also be submitted to the
133 <ulink url="https://sourceforge.net/p/ijbswa/patches/">Sourceforge patch tracker</ulink>.
136 You will also need to have a git package installed,
137 in order to access the git repository.
138 Having the GNU build tools is also going to be important (particularly,
142 For the time being (read, this section is under construction), you can
143 also refer to the extensive comments in the source code. In fact,
144 reading the code is recommended in any case.
149 <!-- ~~~~~ New section ~~~~~ -->
150 <sect1 id="git"><title>The Git Repository</title>
152 If you become part of the active development team, you will eventually
153 need write access to our holy grail, the Git repository. One of the
154 team members will need to set this up for you. Please read
155 this chapter completely before accessing via Git.
158 <sect2 id="gitaccess"><title>Access to Git</title>
160 The project's Git repository is hosted on the
161 <ulink url="https://www.privoxy.org/">Privoxy webserver</ulink>.
162 For Privoxy team members with push privileges the Git repository URL is
163 <literal>ssh://git@git.privoxy.org:23/git/privoxy.git</literal>.
166 Contributors without push privileges can
167 <quote>git clone https://www.privoxy.org/git/privoxy.git</quote>.
170 The central repository is called <literal>privoxy</literal>, and the
171 source branch is called <literal>master</literal>. Subfolders exist
172 within the project for target-dependent build and packaging tools, each
173 including the name of the target operating system in their name (e.g.
174 Windows, OSXPackageBuilder, debian). There is a webview of the Git
176 <ulink url="https://www.privoxy.org/gitweb/?p=privoxy.git;a=tree">
177 https://www.privoxy.org/gitweb/?p=privoxy.git;a=tree</ulink>,
178 which might help with visualizing how these pieces fit together.
182 <sect2 id="gitbranches">
183 <title>Branches</title>
185 Whilst the central repository contains only the master branch, developers
186 are of course free to create branches in their local repositories as they
187 develop features, fixes, or update the target-dependent tools. Only once
188 such changes are fully tested ought they be pushed back to the central
189 repository master branch.
192 Before pushing stuff, please rebase it on a current master so we get
193 an uncomplicated commit history. Avoid merges where possible.
197 Branches are used to fork a sub-development path from the main trunk.
198 Within the <literal>current</literal> module where the sources are, there
199 is always at least one <quote>branch</quote> from the main trunk
200 devoted to a stable release series. The main trunk is where active
201 development takes place for the next stable series (e.g. 3.2.x).
202 So just prior to each stable series (e.g. 3.0.x), a branch is created
203 just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
204 Once the initial stable release of any stable branch has taken place,
205 this branch is <emphasis>only used for bugfixes</emphasis>, which have
206 had prior testing before being committed to Git. (See <link
207 linkend="versionnumbers">Version Numbers</link> below for details on
212 At one time there were two distinct branches: stable and unstable. The
213 more drastic changes were to be in the unstable branch. These branches
214 have now been merged to minimize time and effort of maintaining two
219 This will result in at least two active branches, which means there may
220 be occasions that require the same (or similar) item to be
221 checked into to two different places (assuming its a bugfix and needs
222 fixing in both the stable and unstable trees). This also means that in
223 order to have access to both trees, both will have to be checked out
224 separately. Use the <literal>cvs -r</literal> flag to check out a
225 branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
230 <sect2 id="gitcommit"><title>Git Commit Guidelines</title>
232 The source tree is the heart of every software project. Every effort must
233 be made to ensure that it is readable, compilable and consistent at all
234 times. <!-- There are differing guidelines for the stable branch and the
235 main development trunk, and --> We expect anyone with Git access to strictly
236 adhere to the following guidelines:
240 Basic Guidelines, for all branches:
244 Please don't commit even
245 a small change without testing it thoroughly first. When we're
246 close to a public release, ask a fellow developer to review your
250 Your commit message should give a concise overview of <emphasis>what you
251 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
252 Just check previous messages for good examples.
255 Don't use the same message on multiple files, unless it equally applies to
259 If your changes span multiple files, and the code won't recompile unless
260 all changes are committed (e.g. when changing the signature of a function),
261 then commit all files one after another, without long delays in between.
262 If necessary, prepare the commit messages in advance.
265 Before changing things on Git, make sure that your changes are in line
266 with the team's general consensus on what should be done.
270 Note that near a major public release, we get more cautious.
271 There is always the possibility to submit a patch to the <ulink
272 url="https://sourceforge.net/p/ijbswa/patches/">patch
273 tracker</ulink> or the <ulink
274 url="https://lists.privoxy.org/mailman/listinfo/privoxy-devel">privoxy-devel mailing list</ulink>
282 Stable branches are handled with more care, especially after the
283 initial *.*.0 release, and we are just in bugfix mode. In addition to
284 the above, the below applies only to the stable branch (currently the
285 <literal>v_3_0_branch</literal> branch):
292 Do not commit <emphasis>anything</emphasis> unless your proposed
293 changes have been well tested first, preferably by other members of the
294 project, or have prior approval of the project leaders or consensus
300 Where possible, bugfixes and changes should be tested in the main
301 development trunk first. There may be occasions where this is not
307 Alternately, proposed changes can be submitted as patches output by
308 <literal>git format-patch</literal> to the privoxy-devel mailing list
309 or alternatively to the patch tracker on Sourceforge:
310 <ulink url="https://sourceforge.net/p/ijbswa/patches/">
311 https://sourceforge.net/p/ijbswa/patches/</ulink>.
312 Then ask for peer review.
317 Do not even think about anything except bugfixes. No new features!
328 <!-- ~~~~~ New section ~~~~~ -->
329 <sect1 id="documentation"><title>Documentation Guidelines</title>
331 All formal documents are maintained in Docbook SGML and located in the
332 <computeroutput>doc/source/*</computeroutput> directory. You will need
333 <ulink url="https://www.docbook.org/">Docbook</ulink>, the Docbook
334 DTD's and the Docbook modular stylesheets (or comparable alternatives),
335 and either <application>jade</application> or
336 <application>openjade</application> (recommended) installed in order to
337 build docs from source. Currently there is <ulink
338 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
339 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
340 course this, the <citetitle>developer-manual</citetitle> in this format.
341 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
342 <citetitle>INSTALL</citetitle>,
343 <citetitle>privoxy.1</citetitle> (man page), and
344 <citetitle>config</citetitle> files are also now maintained as Docbook
345 SGML. These files, when built, in the top-level source directory are
346 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
347 variation on this file, <filename>privoxy-index.html</filename>,
348 meant for inclusion with doc packages), are maintained as SGML as well.
349 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
350 contact someone involved in the documentation.
353 <filename>config</filename> requires some special handling. The reason it
354 is maintained this way is so that the extensive comments in the file
355 mirror those in <citetitle>user-manual</citetitle>. But the conversion
356 process requires going from SGML to HTML to text to special formatting
357 required for the embedded comments. Some of this does not survive so
358 well. Especially some of the examples that are longer than 80 characters.
361 Other, less formal documents (e.g. <filename>LICENSE</filename>) are
362 maintained as plain text files in the top-level source directory.
365 Packagers are encouraged to include this documentation. For those without
366 the ability to build the docs locally, text versions of each are kept in
367 Git. HTML versions are also being kept in Git under
368 <filename>doc/webserver/*</filename>.
371 Formal documents are built with the Makefile targets of
372 <computeroutput>make dok</computeroutput>.
373 The build process uses the document SGML sources in
374 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
375 <computeroutput>doc/text/</computeroutput> and to update all HTML
376 documents in <computeroutput>doc/webserver/</computeroutput>.
379 Documentation writers should please make sure documents build
380 successfully before committing to Git, if possible.
383 How do you update the webserver (i.e. the pages on privoxy.org)?
386 <orderedlist numeration="arabic">
388 First, build the docs by running <computeroutput>make
389 dok dok-tidy</computeroutput>.
392 Run <computeroutput>make webserver</computeroutput> which copies all
393 files from <computeroutput>doc/webserver</computeroutput> to the
394 sourceforge webserver via ssh.
399 Finished docs should be occasionally submitted to Git
400 (<filename>doc/webserver/*/*.html</filename>) so that those without
401 the ability to build them locally, have access to them if needed.
402 This is especially important just prior to a new release! Please
403 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
404 other release specific data in <filename>configure.in</filename> has been
405 updated (this is done just prior to a new release).
408 <!-- ~~~~~ New section ~~~~~ -->
410 <title>Quickstart to Docbook and SGML</title>
412 If you are not familiar with SGML, it is a markup language similar to HTML.
413 Actually, not a mark up language per se, but a language used to define
414 markup languages. In fact, HTML is an SGML application. Both will use
415 <quote>tags</quote> to format text and other content. SGML tags can be much
416 more varied, and flexible, but do much of the same kinds of things. The tags,
417 or <quote>elements</quote>, are definable in SGML. There is no set
418 <quote>standards</quote>. Since we are using
419 <application>Docbook</application>, our tags are those that are defined by
420 <application>Docbook</application>. Much of how the finish document is
421 rendered is determined by the <quote>stylesheets</quote>.
422 The stylesheets determine how each tag gets translated to HTML, or other
427 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
428 will likely generate errors. Example: <literal><title>My
429 Title</title></literal>. They are also case-insensitive, but we
430 strongly suggest using all lower case. This keeps compatibility with
431 [Docbook] <application>XML</application>.
435 Our documents use <quote>sections</quote> for the most part. Sections
436 will be processed into HTML headers (e.g. <literal>h1</literal> for
437 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
438 will use these to also generate the Table of Contents for each doc. Our
439 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
440 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
441 entries, but <literal>sect4</literal> will not. Each section requires
442 a <literal><title></literal> element, and at least one
443 <literal><para></literal>. There is a limit of five section
444 levels in Docbook, but generally three should be sufficient for our
449 Some common elements that you likely will use:
454 <emphasis><para></para></emphasis>, paragraph delimiter. Most
455 text needs to be within paragraph elements (there are some exceptions).
458 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
462 <emphasis><filename></filename></emphasis>, files and directories.
465 <emphasis><command></command></emphasis>, command examples.
468 <emphasis><literallayout></literallayout></emphasis>, like
469 <literal><pre></literal>, more or less.
472 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
475 <emphasis><listitem></listitem></emphasis>, member of the above.
478 <emphasis><screen></screen></emphasis>, screen output, implies
479 <literal><literallayout></literal>.
482 <emphasis><ulink url="example.com"></ulink></emphasis>, like
483 HTML <literal><a></literal> tag.
486 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
491 Look at any of the existing docs for examples of all these and more.
496 <!-- <quote><ulink url="http://opensource.bureau-cornavin.com/crash-course/index.html">
497 domain no longer exists so link to the wayback archive -->
498 <quote><ulink url="https://web.archive.org/web/20160315230758/http://opensource.bureau-cornavin.com/crash-course/index.html">
499 Writing Documentation Using DocBook - A Crash Course</ulink></quote> useful.
503 <!-- ~~~~~ New section ~~~~~ -->
504 <sect2 id="docstyle">
505 <title><application>Privoxy</application> Documentation Style</title>
507 It will be easier if everyone follows a similar writing style. This
508 just makes it easier to read what someone else has written if it
509 is all done in a similar fashion.
517 All tags should be lower case.
522 Tags delimiting a <emphasis>block</emphasis> of text (even small
523 blocks) should be on their own line. Like:
531 Tags marking individual words, or few words, should be in-line:
534 Just to <emphasis>emphasize</emphasis>, some text goes here.
539 Tags should be nested and step indented for block text like: (except
547 Some text goes here in our list example.
550 </itemizedlist>
554 This makes it easier to find the text amongst the tags ;-)
559 Use white space to separate logical divisions within a document,
560 like between sections. Running everything together consistently
561 makes it harder to read and work on.
566 Do not hesitate to make comments. Comments can either use the
567 <comment> element, or the <!-- --> style comment
568 familiar from HTML. (Note in Docbook v4.x <comment> is
569 replaced by <remark>.)
574 We have an international audience. Refrain from slang, or English
575 idiosyncrasies (too many to list :). Humor also does not translate
581 Try to keep overall line lengths in source files to 80 characters or less
582 for obvious reasons. This is not always possible, with lengthy URLs for
588 Our documents are available in differing formats. Right now, they
589 are just plain text and/or HTML, but others are always a
590 future possibility. Be careful with URLs (<ulink>), and avoid
594 My favorite site is <ulink url="http://example.com">here</ulink>.
597 This will render as <quote>My favorite site is here</quote>, which is
598 not real helpful in a text doc. Better like this:
601 My favorite site is <ulink url="http://example.com">example.com</ulink>.
606 All documents should be spell checked occasionally.
607 <application>aspell</application> can check SGML with the
608 <literal>-H</literal> option. (<application>ispell</application> I think
618 <!-- ~~~~~ New section ~~~~~ -->
620 <sect2 id="custom-entities"><title>Privoxy Custom Entities</title>
622 <application>Privoxy</application> documentation is using
623 a number of customized <quote>entities</quote> to facilitate
624 documentation maintenance.
627 We are using a set of <quote>boilerplate</quote> files with generic text,
628 that is used by multiple docs. This way we can write something once, and use
629 it repeatedly without having to re-write the same content over and over again.
630 If editing such a file, keep in mind that it should be
631 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
632 contexts without additional modifications.
635 We are also using what <application>Docbook</application> calls
636 <quote>internal entities</quote>. These are like variables in
637 programming. Well, sort of. For instance, we have the
638 <literal>p-version</literal> entity that contains the current
639 <application>Privoxy</application> version string. You are strongly
640 encouraged to use these where possible. Some of these obviously
641 require re-setting with each release (done by the Makefile). A sampling of
642 custom entities are listed below. See any of the main docs for examples.
648 Re- <quote>boilerplate</quote> text entities are defined like:
651 <literal><!entity supported SYSTEM "supported.sgml"></literal>
654 In this example, the contents of the file,
655 <filename>supported.sgml</filename> is available for inclusion anywhere
656 in the doc. To make this happen, just reference the now defined
657 entity: <literal>&supported;</literal> (starts with an ampersand
658 and ends with a semi-colon), and the contents will be dumped into
659 the finished doc at that point.
665 Commonly used <quote>internal entities</quote>:
669 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
670 version string, e.g. <quote>&p-version;</quote>.
673 <emphasis>p-status</emphasis>: the project status, either
674 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
677 <emphasis>p-not-stable</emphasis>: use to conditionally include
678 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
681 <emphasis>p-stable</emphasis>: just the opposite.
684 <emphasis>p-text</emphasis>: this doc is only generated as text.
690 There are others in various places that are defined for a specific
691 purpose. Read the source!
698 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
699 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
701 <!-- ~~~~~ New section ~~~~~ -->
702 <sect1 id="coding"><title>Coding Guidelines</title>
704 <sect2 id="s1"><title>Introduction</title>
706 <para>This set of standards is designed to make our lives easier. It is
707 developed with the simple goal of helping us keep the "new and improved
708 <application>Privoxy</application>" consistent and reliable. Thus making
709 maintenance easier and increasing chances of success of the
712 <para>And that of course comes back to us as individuals. If we can
713 increase our development and product efficiencies then we can solve more
714 of the request for changes/improvements and in general feel good about
715 ourselves. ;-></para>
719 <sect2 id="s2"><title>Using Comments</title>
722 <sect3 id="s3"><title>Comment, Comment, Comment</title>
724 <para><emphasis>Explanation:</emphasis></para>
726 <para>Comment as much as possible without commenting the obvious.
727 For example do not comment "variable_a is equal to variable_b".
728 Instead explain why variable_a should be equal to the variable_b.
729 Just because a person can read code does not mean they will
730 understand why or what is being done. A reader may spend a lot
731 more time figuring out what is going on when a simple comment
732 or explanation would have prevented the extra research. Please
733 help your fellow Privoxy developers out!</para>
735 <para>The comments will also help justify the intent of the code.
736 If the comment describes something different than what the code
737 is doing then maybe a programming error is occurring.</para>
739 <para><emphasis>Example:</emphasis></para>
741 /* if page size greater than 1k ... */
742 if (page_length() > 1024)
744 ... "block" the page up ...
747 /* if page size is small, send it in blocks */
748 if (page_length() > 1024)
750 ... "block" the page up ...
753 This demonstrates 2 cases of "what not to do". The first is a
754 "syntax comment". The second is a comment that does not fit what
755 is actually being done.
761 <sect3 id="s4"><title>Use blocks for comments</title>
763 <para><emphasis>Explanation:</emphasis></para>
765 <para>Comments can help or they can clutter. They help when they
766 are differentiated from the code they describe. One line
767 comments do not offer effective separation between the comment
768 and the code. Block identifiers do, by surrounding the code
769 with a clear, definable pattern.</para>
771 <para><emphasis>Example:</emphasis></para>
773 /*********************************************************************
774 * This will stand out clearly in your code!
775 *********************************************************************/
776 if (this_variable == that_variable)
778 do_something_very_important();
782 /* unfortunately, this may not */
783 if (this_variable == that_variable)
785 do_something_very_important();
789 if (this_variable == that_variable) /* this may not either */
791 do_something_very_important();
794 <para><emphasis>Exception:</emphasis></para>
796 <para>If you are trying to add a small logic comment and do not
797 wish to "disrupt" the flow of the code, feel free to use a 1
798 line comment which is NOT on the same line as the code.</para>
804 <sect3 id="s5"><title>Keep Comments on their own line</title>
806 <para><emphasis>Explanation:</emphasis></para>
808 <para>It goes back to the question of readability. If the comment
809 is on the same line as the code it will be harder to read than
810 the comment that is on its own line.</para>
812 <para>There are three exceptions to this rule, which should be
813 violated freely and often: during the definition of variables,
814 at the end of closing braces, when used to comment
817 <para><emphasis>Example:</emphasis></para>
819 /*********************************************************************
820 * This will stand out clearly in your code,
821 * But the second example won't.
822 *********************************************************************/
823 if (this_variable == this_variable)
825 do_something_very_important();
828 if (this_variable == this_variable) /*can you see me?*/
830 do_something_very_important(); /*not easily*/
834 /*********************************************************************
835 * But, the encouraged exceptions:
836 *********************************************************************/
837 int urls_read = 0; /* # of urls read + rejected */
838 int urls_rejected = 0; /* # of urls rejected */
842 do_something_very_important();
846 short do_something_very_important(
847 short firstparam, /* represents something */
848 short nextparam /* represents something else */ )
852 } /* -END- do_something_very_important */
857 <sect3 id="s6"><title>Comment each logical step</title>
859 <para><emphasis>Explanation:</emphasis></para>
861 <para>Logical steps should be commented to help others follow the
862 intent of the written code and comments will make the code more
865 <para>If you have 25 lines of code without a comment, you should
866 probably go back into it to see where you forgot to put
869 <para>Most "for", "while", "do", etc... loops _probably_ need a
870 comment. After all, these are usually major logic
877 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
879 <para><emphasis>Explanation:</emphasis></para>
881 <para>A reader of the code should be able to look at the comments
882 just prior to the beginning of a function and discern the
883 reason for its existence and the consequences of using it. The
884 reader should not have to read through the code to determine if
885 a given function is safe for a desired use. The proper
886 information thoroughly presented at the introduction of a
887 function not only saves time for subsequent maintenance or
888 debugging, it more importantly aids in code reuse by allowing a
889 user to determine the safety and applicability of any function
890 for the problem at hand. As a result of such benefits, all
891 functions should contain the information presented in the
892 addendum section of this document.</para>
898 <sect3 id="s8"><title>Comment at the end of braces if the
899 content is more than one screen length</title>
901 <para><emphasis>Explanation:</emphasis></para>
903 <para>Each closing brace should be followed on the same line by a
904 comment that describes the origination of the brace if the
905 original brace is off of the screen, or otherwise far away from
906 the closing brace. This will simplify the debugging,
907 maintenance, and readability of the code.</para>
909 <para>As a suggestion , use the following flags to make the
910 comment and its brace more readable:</para>
912 <para>use following a closing brace: } /* -END- if() or while ()
915 <para><emphasis>Example:</emphasis></para>
919 do_something_very_important();
920 ...some long list of commands...
921 } /* -END- if x is 1 */
927 do_something_very_important();
928 ...some long list of commands...
929 } /* -END- if (1 == X) */
935 <sect2 id="s9"><title>Naming Conventions</title>
939 <sect3 id="s10"><title>Variable Names</title>
941 <para><emphasis>Explanation:</emphasis></para>
943 <para>Use all lowercase, and separate words via an underscore
944 ('_'). Do not start an identifier with an underscore. (ANSI C
945 reserves these for use by the compiler and system headers.) Do
946 not use identifiers which are reserved in ANSI C++. (E.g.
947 template, class, true, false, ...). This is in case we ever
948 decide to port Privoxy to C++.</para>
950 <para><emphasis>Example:</emphasis></para>
952 int ms_iis5_hack = 0;</programlisting>
954 <para><emphasis>Instead of:</emphasis></para>
957 int msiis5hack = 0; int msIis5Hack = 0;
964 <sect3 id="s11"><title>Function Names</title>
966 <para><emphasis>Explanation:</emphasis></para>
968 <para>Use all lowercase, and separate words via an underscore
969 ('_'). Do not start an identifier with an underscore. (ANSI C
970 reserves these for use by the compiler and system headers.) Do
971 not use identifiers which are reserved in ANSI C++. (E.g.
972 template, class, true, false, ...). This is in case we ever
973 decide to port Privoxy to C++.</para>
975 <para><emphasis>Example:</emphasis></para>
977 int load_some_file(struct client_state *csp)</programlisting>
979 <para><emphasis>Instead of:</emphasis></para>
982 int loadsomefile(struct client_state *csp)
983 int loadSomeFile(struct client_state *csp)
990 <sect3 id="s12"><title>Header file prototypes</title>
992 <para><emphasis>Explanation:</emphasis></para>
994 <para>Use a descriptive parameter name in the function prototype
995 in header files. Use the same parameter name in the header file
996 that you use in the c file.</para>
998 <para><emphasis>Example:</emphasis></para>
1000 (.h) extern int load_aclfile(struct client_state *csp);
1001 (.c) int load_aclfile(struct client_state *csp)</programlisting>
1003 <para><emphasis>Instead of:</emphasis></para>
1005 (.h) extern int load_aclfile(struct client_state *); or
1006 (.h) extern int load_aclfile();
1007 (.c) int load_aclfile(struct client_state *csp)
1014 <sect3 id="s13"><title>Enumerations, and #defines</title>
1016 <para><emphasis>Explanation:</emphasis></para>
1018 <para>Use all capital letters, with underscores between words. Do
1019 not start an identifier with an underscore. (ANSI C reserves
1020 these for use by the compiler and system headers.)</para>
1022 <para><emphasis>Example:</emphasis></para>
1024 (enumeration) : enum Boolean {FALSE, TRUE};
1025 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1027 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1028 that toggle a feature in the preprocessor: FEATURE_>, where
1029 > is a short (preferably 1 or 2 word) description.</para>
1031 <para><emphasis>Example:</emphasis></para>
1033 #define FEATURE_FORCE 1
1035 #ifdef FEATURE_FORCE
1036 #define FORCE_PREFIX blah
1037 #endif /* def FEATURE_FORCE */
1042 <sect3 id="s14"><title>Constants</title>
1044 <para><emphasis>Explanation:</emphasis></para>
1046 <para>Spell common words out entirely (do not remove vowels).</para>
1048 <para>Use only widely-known domain acronyms and abbreviations.
1049 Capitalize all letters of an acronym.</para>
1051 <para>Use underscore (_) to separate adjacent acronyms and
1052 abbreviations. Never terminate a name with an underscore.</para>
1054 <para><emphasis>Example:</emphasis></para>
1056 #define USE_IMAGE_LIST 1</programlisting>
1058 <para><emphasis>Instead of:</emphasis></para>
1061 #define USE_IMG_LST 1 or
1062 #define _USE_IMAGE_LIST 1 or
1063 #define USE_IMAGE_LIST_ 1 or
1064 #define use_image_list 1 or
1065 #define UseImageList 1
1074 <sect2 id="s15"><title>Using Space</title>
1078 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1080 <para><emphasis>Explanation:</emphasis></para>
1082 <para>The brace needs to be on a line all by itself, not at the
1083 end of the statement. Curly braces should line up with the
1084 construct that they're associated with. This practice makes it
1085 easier to identify the opening and closing braces for a
1088 <para><emphasis>Example:</emphasis></para>
1095 <para><emphasis>Instead of:</emphasis></para>
1097 <para>if (this == that) { ... }</para>
1101 <para>if (this == that) { ... }</para>
1103 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1104 inside a loop, and it is trivial, i.e. it tests for a
1105 condition that is obvious from the purpose of the block,
1106 one-liners as above may optically preserve the loop structure
1107 and make it easier to read.</para>
1109 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1111 <para><emphasis>Example exception:</emphasis></para>
1113 while (more lines are read)
1115 /* Please document what is/is not a comment line here */
1116 if (it's a comment) continue;
1124 <sect3 id="s17"><title>ALL control statements should have a
1127 <para><emphasis>Explanation:</emphasis></para>
1129 <para>Using braces to make a block will make your code more
1130 readable and less prone to error. All control statements should
1131 have a block defined.</para>
1133 <para><emphasis>Example:</emphasis></para>
1138 do_something_else();
1141 <para><emphasis>Instead of:</emphasis></para>
1143 <para>if (this == that) do_something(); do_something_else();</para>
1147 <para>if (this == that) do_something();</para>
1149 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1150 in a manner other than that which the developer desired (per
1151 indentation). Using code braces would have prevented this
1152 "feature". The "explanation" and "exception" from the point
1153 above also applies.</para>
1159 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1162 <para><emphasis>Example:</emphasis></para>
1164 structure->flag = (condition);</programlisting>
1166 <para><emphasis>Instead of:</emphasis></para>
1168 <para>if (condition) { structure->flag = 1; } else {
1169 structure->flag = 0; }</para>
1171 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1172 is wordy and inefficient. Please assume that any developer new
1173 to the project has at least a "good" knowledge of C/C++. (Hope
1174 I do not offend by that last comment ... 8-)</para>
1180 <sect3 id="s19"><title>Use white space freely because it is
1183 <para><emphasis>Explanation:</emphasis></para>
1185 <para>Make it readable. The notable exception to using white space
1186 freely is listed in the next guideline.</para>
1188 <para><emphasis>Example:</emphasis></para>
1190 int first_value = 0;
1192 int another_value = 0;
1193 int this_variable = 0;
1198 <sect3 id="s20"><title>Don't use white space around structure
1201 <para><emphasis>Explanation:</emphasis></para>
1203 <para>- structure pointer operator ( "->" ) - member operator (
1204 "." ) - functions and parentheses</para>
1206 <para>It is a general coding practice to put pointers, references,
1207 and function parentheses next to names. With spaces, the
1208 connection between the object and variable/function name is not
1211 <para><emphasis>Example:</emphasis></para>
1215 function_name();</programlisting>
1217 <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
1218 function_name ();</para>
1224 <sect3 id="s21"><title>Make the last brace of a function stand
1227 <para><emphasis>Example:</emphasis></para>
1229 int function1( ... )
1234 } /* -END- function1 */
1237 int function2( ... )
1239 } /* -END- function2 */
1242 <para><emphasis>Instead of:</emphasis></para>
1244 <para>int function1( ... ) { ...code... return(ret_code); } int
1245 function2( ... ) { }</para>
1247 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1248 lines afterward. This makes the end of function standout to
1249 the most casual viewer. Although function comments help
1250 separate functions, this is still a good coding practice. In
1251 fact, I follow these rules when using blocks in "for", "while",
1252 "do" loops, and long if {} statements too. After all whitespace
1255 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1256 lines. Enforced is the end of function comments.</para>
1262 <sect3 id="s22"><title>Use 3 character indentions</title>
1264 <para><emphasis>Explanation:</emphasis></para>
1266 <para>If some use 8 character TABs and some use 3 character TABs,
1267 the code can look *very* ragged. So use 3 character indentions
1268 only. If you like to use TABs, pass your code through a filter
1269 such as "expand -t3" before checking in your code.</para>
1271 <para><emphasis>Example:</emphasis></para>
1273 static const char * const url_code_map[256] =
1279 int function1( ... )
1287 return HOW_DID_YOU_GET_HERE;
1290 return NEVER_GETS_HERE;
1299 <sect2 id="s23"><title>Initializing</title>
1303 <sect3 id="s24"><title>Initialize all variables</title>
1305 <para><emphasis>Explanation:</emphasis></para>
1307 <para>Do not assume that the variables declared will not be used
1308 until after they have been assigned a value somewhere else in
1309 the code. Remove the chance of accidentally using an unassigned
1312 <para><emphasis>Example:</emphasis></para>
1316 struct *ptr = NULL;</programlisting>
1318 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1319 message says you are trying to access memory address 00000000
1320 and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
1321 array_ptr[0].</para>
1323 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1324 variable is assigned a value "shortly after" declaration.</para>
1330 <sect2 id="s25"><title>Functions</title>
1334 <sect3 id="s26"><title>Name functions that return a boolean as a
1337 <para><emphasis>Explanation:</emphasis></para>
1339 <para>Value should be phrased as a question that would logically
1340 be answered as a true or false statement</para>
1342 <para><emphasis>Example:</emphasis></para>
1344 should_we_block_this();
1345 contains_an_image();
1346 is_web_page_blank();
1351 <sect3 id="s27"><title>Always specify a return type for a
1354 <para><emphasis>Explanation:</emphasis></para>
1356 <para>The default return for a function is an int. To avoid
1357 ambiguity, create a return for a function when the return has a
1358 purpose, and create a void return type if the function does not
1359 need to return anything.</para>
1365 <sect3 id="s28"><title>Minimize function calls when iterating by
1366 using variables</title>
1368 <para><emphasis>Explanation:</emphasis></para>
1370 <para>It is easy to write the following code, and a clear argument
1371 can be made that the code is easy to understand:</para>
1373 <para><emphasis>Example:</emphasis></para>
1375 for (size_t cnt = 0; cnt < block_list_length(); cnt++)
1380 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1381 each and every iteration. This increases the overhead in the
1382 program, because the compiler has to look up the function each
1383 time, call it, and return a value. Depending on what occurs in
1384 the block_list_length() call, it might even be creating and
1385 destroying structures with each iteration, even though in each
1386 case it is comparing "cnt" to the same value, over and over.
1387 Remember too - even a call to block_list_length() is a function
1388 call, with the same overhead.</para>
1390 <para>Instead of using a function call during the iterations,
1391 assign the value to a variable, and evaluate using the
1394 <para><emphasis>Example:</emphasis></para>
1396 size_t len = block_list_length();
1398 for (size_t cnt = 0; cnt < len; cnt++)
1403 <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
1404 *may* change or could *potentially* change, then you must code the
1405 function call in the for/while loop.</para>
1411 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1413 <para><emphasis>Explanation:</emphasis></para>
1415 <para>This allows a developer to define a const pointer and call
1416 your function. If your function does not have the const
1417 keyword, we may not be able to use your function. Consider
1418 strcmp, if it were defined as: extern int strcmp(char *s1,
1421 <para>I could then not use it to compare argv's in main: int
1422 main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
1425 <para>Both these pointers are *const*! If the c runtime library
1426 maintainers do it, we should too.</para>
1432 <sect3 id="s30"><title>Pass and Return by Value</title>
1434 <para><emphasis>Explanation:</emphasis></para>
1436 <para>Most structures cannot fit onto a normal stack entry (i.e.
1437 they are not 4 bytes or less). Aka, a function declaration
1438 like: int load_aclfile(struct client_state csp)</para>
1440 <para>would not work. So, to be consistent, we should declare all
1441 prototypes with "pass by value": int load_aclfile(struct
1442 client_state *csp)</para>
1448 <sect3 id="s31"><title>Names of include files</title>
1450 <para><emphasis>Explanation:</emphasis></para>
1452 <para>Your include statements should contain the file name without
1453 a path. The path should be listed in the Makefile, using -I as
1454 processor directive to search the indicated paths. An exception
1455 to this would be for some proprietary software that utilizes a
1456 partial path to distinguish their header files from system or
1457 other header files.</para>
1459 <para><emphasis>Example:</emphasis></para>
1461 #include <iostream.h> /* This is not a local include */
1462 #include "config.h" /* This IS a local include */
1465 <para><emphasis>Exception:</emphasis></para>
1468 /* This is not a local include, but requires a path element. */
1469 #include <sys/fileName.h>
1472 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1473 without a _very_ good reason. This duplicates the #include
1474 "file.h" behavior.</para>
1480 <sect3 id="s32"><title>Provide multiple inclusion
1483 <para><emphasis>Explanation:</emphasis></para>
1485 <para>Prevents compiler and linker errors resulting from
1486 redefinition of items.</para>
1488 <para>Wrap each header file with the following syntax to prevent
1489 multiple inclusions of the file. Of course, replace PROJECT_H
1490 with your file name, with "." Changed to "_", and make it
1493 <para><emphasis>Example:</emphasis></para>
1495 #ifndef PROJECT_H_INCLUDED
1496 #define PROJECT_H_INCLUDED
1498 #endif /* ndef PROJECT_H_INCLUDED */
1503 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1505 <para><emphasis>Explanation:</emphasis></para>
1507 <para>If our headers are included from C++, they must declare our
1508 functions as `extern "C"`. This has no cost in C, but increases
1509 the potential re-usability of our code.</para>
1511 <para><emphasis>Example:</emphasis></para>
1516 #endif /* def __cplusplus */
1518 ... function definitions here ...
1522 #endif /* def __cplusplus */
1527 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1528 Declaration Instead of Includes</title>
1530 <para><emphasis>Explanation:</emphasis></para>
1532 <para>Useful in headers that include pointers to other struct's.
1533 Modifications to excess header files may cause needless
1536 <para><emphasis>Example:</emphasis></para>
1538 /*********************************************************************
1539 * We're avoiding an include statement here!
1540 *********************************************************************/
1542 extern file_list *xyz;</programlisting>
1544 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1545 pointer), then including the proper header file is necessary.
1546 If you only want to prototype a pointer, however, the header
1547 file is unnecessary.</para>
1549 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1555 <sect2 id="s35"><title>General Coding Practices</title>
1559 <sect3 id="s36"><title>Turn on warnings</title>
1561 <para><emphasis>Explanation</emphasis></para>
1563 <para>Compiler warnings are meant to help you find bugs. You
1564 should turn on as many as possible. With GCC, the switch is
1565 "-Wall". Try and fix as many warnings as possible.</para>
1571 <sect3 id="s37"><title>Provide a default case for all switch
1574 <para><emphasis>Explanation:</emphasis></para>
1576 <para>What you think is guaranteed is never really guaranteed. The
1577 value that you don't think you need to check is the one that
1578 someday will be passed. So, to protect yourself from the
1579 unknown, always have a default step in a switch statement.</para>
1581 <para><emphasis>Example:</emphasis></para>
1583 switch (hash_string(cmd))
1585 case hash_actions_file:
1595 ... anomaly code goes here ...
1596 continue; / break; / exit( 1 ); / etc ...
1598 } /* end switch (hash_string(cmd)) */</programlisting>
1600 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1601 are obviously exempt from this point. Of note, most of the
1602 WIN32 code calls `DefWindowProc' after the switch statement.
1603 This API call *should* be included in a default statement.</para>
1605 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1606 as a robust programming issue. The "anomaly code goes here" may
1607 be no more than a print to the STDERR stream (as in
1608 load_config). Or it may really be an abort condition.</para>
1610 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1616 <sect3 id="s38"><title>Try to avoid falling through cases in a
1617 switch statement.</title>
1619 <para><emphasis>Explanation:</emphasis></para>
1621 <para>In general, you will want to have a 'break' statement within
1622 each 'case' of a switch statement. This allows for the code to
1623 be more readable and understandable, and furthermore can
1624 prevent unwanted surprises if someone else later gets creative
1625 and moves the code around.</para>
1627 <para>The language allows you to plan the fall through from one
1628 case statement to another simply by omitting the break
1629 statement within the case statement. This feature does have
1630 benefits, but should only be used in rare cases. In general,
1631 use a break statement for each case statement.</para>
1633 <para>If you choose to allow fall through, you should comment both
1634 the fact of the fall through and reason why you felt it was
1641 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1643 <para><emphasis>Explanation:</emphasis></para>
1645 <para>The type of size_t varies across platforms. Do not make
1646 assumptions about whether it is signed or unsigned, or about
1647 how long it is. Do not compare a size_t against another
1648 variable of a different type (or even against a constant)
1649 without casting one of the values.</para>
1655 <sect3 id="s41"><title>Declare each variable and struct on its
1658 <para><emphasis>Explanation:</emphasis></para>
1660 <para>It can be tempting to declare a series of variables all on
1661 one line. Don't.</para>
1663 <para><emphasis>Example:</emphasis></para>
1667 long c = 0;</programlisting>
1669 <para><emphasis>Instead of:</emphasis></para>
1671 <para>long a, b, c;</para>
1673 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1674 individual variables - easier to add new variables without
1675 messing up the original ones - when searching on a variable to
1676 find its type, there is less clutter to "visually"
1679 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1680 variables or other trivial variables; feel free to declare them
1681 on one line. You should, although, provide a good comment on
1682 their functions.</para>
1684 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1690 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1692 <para><emphasis>Explanation:</emphasis></para>
1694 <para>Create a local struct (on the stack) if the variable will
1695 live and die within the context of one function call.</para>
1697 <para>Only "malloc" a struct (on the heap) if the variable's life
1698 will extend beyond the context of one function call.</para>
1700 <para><emphasis>Example:</emphasis></para>
1702 If a function creates a struct and stores a pointer to it in a
1703 list, then it should definitely be allocated via `malloc'.
1708 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1709 Responsible for Ensuring 'free'</title>
1711 <para><emphasis>Explanation:</emphasis></para>
1713 <para>If you have to "malloc" an instance, you are responsible for
1714 insuring that the instance is `free'd, even if the deallocation
1715 event falls within some other programmer's code. You are also
1716 responsible for ensuring that deletion is timely (i.e. not too
1717 soon, not too late). This is known as "low-coupling" and is a
1718 "good thing (tm)". You may need to offer a
1719 free/unload/destructor type function to accommodate this.</para>
1721 <para><emphasis>Example:</emphasis></para>
1723 int load_re_filterfile(struct client_state *csp) { ... }
1724 static void unload_re_filterfile(void *f) { ... }</programlisting>
1726 <para><emphasis>Exceptions:</emphasis></para>
1728 <para>The developer cannot be expected to provide `free'ing
1729 functions for C run-time library functions ... such as
1732 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1733 standard is for allocating and freeing data structures (complex
1740 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1741 and in order</title>
1743 <para><emphasis>Explanation:</emphasis></para>
1745 <para>I have ordered all of the "blocker" file code to be in alpha
1746 order. It is easier to add/read new blockers when you expect a
1747 certain order.</para>
1749 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1750 places by POPUP tests coming before PCRS tests. But since
1751 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1752 it should come first.</para>
1758 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1759 existing code, use XXX</title>
1761 <para><emphasis>Explanation:</emphasis></para>
1763 <para>If you have enough confidence in new code or confidence in
1764 your changes, but are not *quite* sure of the repercussions,
1767 <para>/* XXX: this code has a logic error on platform XYZ, *
1768 attempting to fix */ #ifdef PLATFORM ...changed code here...
1773 <para>/* XXX: I think the original author really meant this...
1774 */ ...changed code here...</para>
1778 <para>/* XXX: new code that *may* break something else... */
1779 ...new code here...</para>
1781 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1782 be a "good thing (tm)", it will be easier to identify and
1783 include in the project (or conversely exclude from the
1791 <sect2 id="s46"><title>Addendum: Template for files and function
1792 comment blocks:</title>
1794 <para><emphasis>Example for file comments:</emphasis></para>
1796 /*********************************************************************
1800 * Purpose : (Fill me in with a good description!)
1802 * Copyright : Written by and Copyright (C) 2001-2009
1803 * the Privoxy team. https://www.privoxy.org/
1805 * This program is free software; you can redistribute it
1806 * and/or modify it under the terms of the GNU General
1807 * Public License as published by the Free Software
1808 * Foundation; either version 2 of the License, or (at
1809 * your option) any later version.
1811 * This program is distributed in the hope that it will
1812 * be useful, but WITHOUT ANY WARRANTY; without even the
1813 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1814 * PARTICULAR PURPOSE. See the GNU General Public
1815 * License for more details.
1817 * The GNU General Public License should be included with
1818 * this file. If not, you can view it at
1819 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1820 * or write to the Free Software Foundation, Inc.,
1821 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1824 *********************************************************************/
1829 ...necessary include files for us to do our work...
1831 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1834 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1835 added to the "show-version" page. If this is a brand new
1836 creation by you, you are free to change the "Copyright" section
1837 to represent the rights you wish to maintain.</para>
1839 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1840 after the comment flower box is handy for (X|GNU)Emacs users to
1841 skip the verbiage and get to the heart of the code (via
1842 `forward-page' and `backward-page'). Please include it if you
1845 <para><emphasis>Example for file header comments:</emphasis></para>
1849 /*********************************************************************
1853 * Purpose : (Fill me in with a good description!)
1855 * Copyright : Written by and Copyright (C) 2001-2009
1856 * the Privoxy team. https://www.privoxy.org/
1858 * This program is free software; you can redistribute it
1859 * and/or modify it under the terms of the GNU General
1860 * Public License as published by the Free Software
1861 * Foundation; either version 2 of the License, or (at
1862 * your option) any later version.
1864 * This program is distributed in the hope that it will
1865 * be useful, but WITHOUT ANY WARRANTY; without even the
1866 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1867 * PARTICULAR PURPOSE. See the GNU General Public
1868 * License for more details.
1870 * The GNU General Public License should be included with
1871 * this file. If not, you can view it at
1872 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1873 * or write to the Free Software Foundation, Inc.,
1874 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1877 *********************************************************************/
1880 #include "project.h"
1886 ... function headers here ...
1889 /* Revision control strings from this header and associated .c file */
1890 extern const char FILENAME_rcs[];
1891 extern const char FILENAME_h_rcs[];
1898 #endif /* ndef _FILENAME_H */
1907 <para><emphasis>Example for function comments:</emphasis></para>
1909 /*********************************************************************
1911 * Function : FUNCTION_NAME
1913 * Description : (Fill me in with a good description!)
1916 * 1 : param1 = pointer to an important thing
1917 * 2 : x = pointer to something else
1919 * Returns : 0 => Ok, everything else is an error.
1921 *********************************************************************/
1922 int FUNCTION_NAME(void *param1, const char *x)
1930 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1931 able to parse our code to create a "self-documenting" web
1938 <!-- ~~~~~ New section ~~~~~ -->
1939 <sect1 id="testing"><title>Testing Guidelines</title>
1943 <!-- ~~~~~ New section ~~~~~ -->
1944 <sect2 id="testing-plan"><title>Testplan for releases</title>
1946 Explain release numbers. major, minor. developer releases. etc.
1948 <orderedlist numeration="arabic">
1950 Remove any existing rpm with rpm -e
1953 Remove any file that was left over. This includes (but is not limited to)
1956 <listitem><para>/var/log/privoxy</para></listitem>
1957 <listitem><para>/etc/privoxy</para></listitem>
1958 <listitem><para>/usr/sbin/privoxy</para></listitem>
1959 <listitem><para>/etc/init.d/privoxy</para></listitem>
1960 <listitem><para>/usr/doc/privoxy*</para></listitem>
1964 Install the rpm. Any error messages?
1966 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1967 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1968 autostart work?</para></listitem>
1969 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1970 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1973 <!-- XXX: Document how to write test reports and where to send them -->
1975 <!-- ~~~~~ New section ~~~~~ -->
1976 <sect2 id="privoxy-regression-test"><title>Testing with <application>Privoxy-Regression-Test</application></title>
1978 If you compiled, packaged or merely installed Privoxy, it is recommended to run
1979 <application>Privoxy-Regression-Test</application> to verify that at least
1980 the tested parts of <application>Privoxy</application> are working as expected.
1983 This is actually pretty easy. For details, please see
1984 <command>perldoc privoxy-regression-test.pl</command>.
1987 Here is an example of what <application>Privoxy-Regression-Test</application> can do for you:
1991 fk@t520 ~ $privoxy-regression-test.pl
1992 2020-12-14 12:16:32: Asking Privoxy for the number of action files available ...
1993 2020-12-14 12:16:32: Gathering regression tests from 9 action file(s) delivered by Privoxy 3.0.30.
1994 2020-12-14 12:16:32: Executing regression tests ...
1995 2020-12-14 12:16:41: Ooops. Expected removal but: 'Referer: https://p.p/' is still there.
1996 2020-12-14 12:16:41: Failure for test 785. Header 'Referer: https://p.p/' and tag 'hide-referrer{conditional-block}'
1997 2020-12-14 12:16:41: Ooops. Got: 'Referer: https://p.p/' while expecting: 'Referer: http://p.p/'
1998 2020-12-14 12:16:41: Failure for test 791. Header 'Referer: https://p.p/' and tag 'hide-referrer{conditional-forge}'
1999 2020-12-14 12:16:44: Executed 1087 regression tests. Skipped 115. 1085 successes, 2 failures.
2000 # Repeat one of the failing tests and get a curl command to quickly reproduce the problem
2001 # without causing too much log noise.
2002 fk@t520 ~ $privoxy-regression-test.pl --test-number 785 --verbose --debug 39
2003 2020-12-14 12:17:55: Asking Privoxy for the number of action files available ...
2005 2020-12-14 12:17:56: Executing regression tests ...
2006 2020-12-14 12:17:56: Executing: curl --include -H 'Proxy-Connection:' -H 'Connection: close' -s -S --user-agent 'Privoxy-Regression-Test 0.7.2' --max-time '5' --globoff -H 'X-Privoxy-Control: hide-referrer{conditional-block}' -H 'Referer: https://p.p/' http://p.p/show-request 2>&1
2007 2020-12-14 12:17:56: Ooops. Expected removal but: 'Referer: https://p.p/' is still there.
2008 2020-12-14 12:17:56: Failure for test 785 (0/13/5). Header 'Referer: https://p.p/' and tag 'hide-referrer{conditional-block}'
2009 2020-12-14 12:17:56: Executed 1 regression tests. Skipped 1201. 0 successes, 1 failures.
2012 Use the if the <command>--privoxy-address</command> option if the
2013 http_proxy environment variable isn't configured.
2017 <!-- ~~~~~ New section ~~~~~ -->
2018 <sect2 id="fuzzing"><title>Fuzzing Privoxy</title>
2020 To make fuzzing more convenient, Privoxy can be configured
2021 with --enable-fuzz which will result in the --fuzz option
2025 Example (tested on ElectroBSD):
2028 # Compile Privoxy with instrumentation for afl
2029 $ export CC=afl-clang
2030 $ export CFLAGS="-fsanitize=address -ggdb"
2031 $ export CPPFLAGS=-I/usr/local/include/
2032 $ export LDFLAGS="-fsanitize=address -L/usr/local/lib"
2033 $ export AFL_USE_ASAN=1
2034 $ export AFL_HARDEN=1
2035 $ ./configure --with-debug --enable-extended-host-patterns --enable-accept-filter --enable-no-gifs --enable-compression --enable-strptime-sanity-checks --enable-external-filters --enable-fuzz
2038 Privoxy version 3.0.24 (http://www.privoxy.org/)
2039 Usage: ./privoxy [--config-test] [--chroot] [--help] [--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] [--version] [configfile]
2040 ./privoxy --fuzz fuzz-mode ./path/to/fuzzed/input [--stfu]
2042 Supported fuzz modes and the expected input:
2043 action: Text to parse as action file.
2044 client-request: Client request to parse. Currently incomplete
2045 client-header: Client header to parse.
2046 chunked-transfer-encoding: Chunk-encoded data to dechunk.
2047 deflate: deflate-compressed data to decompress.
2048 filter: Text to parse as filter file.
2049 gif: gif to deanimate.
2050 gzip: gzip-compressed data to decompress.
2051 pcrs-substitute: A pcrs-substitute to compile. Not a whole pcrs job! Example: Bla $1 bla C $3 blah.
2052 server-header: Server header to parse.
2053 server-response: Server response to parse.
2055 The following fuzz modes read data from stdin if the 'file' is '-'
2058 chunked-transfer-encoding
2068 $ export ASAN_OPTIONS='abort_on_error=1'
2069 $ mkdir input output
2070 $ echo '$1 bla fasel $2' > input/pcrs
2071 $ afl-fuzz -i input -o output -m none ~/git/privoxy/privoxy --fuzz pcrs-substitute - --stfu
2073 $ cat >input/pcrs.txt
2075 s@(.{1})[432](\d+)@$1$2$hostname@UgisT
2077 $ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla.filter --stfu
2082 <!-- ~~~~~ New section ~~~~~ -->
2083 <sect1 id="newrelease"><title>Releasing a New Version</title>
2085 When we release versions of <application>Privoxy</application>,
2086 our work leaves our cozy secret lab and has to work in the cold
2087 RealWorld[tm]. Once it is released, there is no way to call it
2088 back, so it is very important that great care is taken to ensure
2089 that everything runs fine, and not to introduce problems in the
2093 So when releasing a new version, please adhere exactly to the
2094 procedure outlined in this chapter.
2098 The following programs are required to follow this process:
2099 <filename>ssh</filename>,
2100 <filename>gmake</filename> (GNU's version of make), autoconf, git,
2104 <sect2 id="versionnumbers">
2105 <title>Version numbers</title>
2108 First you need to determine which version number the release will have.
2109 <application>Privoxy</application> version numbers consist of three numbers,
2110 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2115 X, the version major, is rarely ever changed. It is increased by one if
2116 turning a development branch into stable substantially changes the functionality,
2117 user interface or configuration syntax. Majors 1 and 2 were
2118 <application>Junkbuster</application>, and 3 is the first stable
2119 <application>Privoxy</application> release.
2124 <!-- FIXME this is not the way it works anymore -->
2125 Y, the version minor, represents the branch within the major version.
2126 At any point in time, there are two branches being maintained:
2127 The stable branch, with an even minor, say, 2N, in which no functionality is
2128 being added and only bug-fixes are made, and 2N+1, the development branch, in
2129 which the further development of <application>Privoxy</application> takes
2131 This enables us to turn the code upside down and inside out, while at the same time
2132 providing and maintaining a stable version.
2133 The minor is reset to zero (and one) when the major is incremented. When a development
2134 branch has matured to the point where it can be turned into stable, the old stable branch
2135 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2136 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2141 Z, the point or sub version, represents a release of the software within a branch.
2142 It is therefore incremented immediately after each software release.
2143 <!-- FIXME this is not the way it works any more
2144 In development branches, only the even point versions correspond to actual releases,
2145 while the odd ones denote the evolving state of the sources on Git in between.
2146 It follows that Z is odd on Git in development branches most of the time. There, it gets
2147 increased to an even number immediately before a code freeze, and is increased to an odd
2148 number again immediately thereafter.
2149 This ensures that builds from Git snapshots are easily distinguished from released versions.
2150 didn't Fabian get rid of the even=stable, odd=dev convention for release numbering? -->
2151 The point version is reset to zero when the minor changes.
2154 Stable branches work a little differently, since there should be
2155 little to no development happening in such branches. Remember,
2156 only bugfixes, which presumably should have had some testing
2157 before being committed. Stable branches will then have their
2158 version reported as <literal>0.0.0</literal>, during that period
2159 between releases when changes are being added. This is to denote
2160 that this code is <emphasis>not for release</emphasis>. Then
2161 as the release nears, the version is bumped according: e.g.
2162 <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2167 In summary, the main Git trunk is the development branch where new
2168 features are being worked on for the next stable series. This should
2169 almost always be where the most activity takes place. There is always at
2170 least one stable branch from the trunk, e.g now it is
2171 <literal>3.0</literal>, which is only used to release stable versions.
2172 Once the initial *.0 release of the stable branch has been done, then as a
2173 rule, only bugfixes that have had prior testing should be committed to
2174 the stable branch. Once there are enough bugfixes to justify a new
2175 release, the version of this branch is again incremented Example: 3.0.0
2176 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2177 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2178 taking place. If any questions, please post to the devel list
2179 <emphasis>before</emphasis> committing to a stable branch!
2182 Developers should remember too that if they commit a bugfix to the stable
2183 branch, this will more than likely require a separate submission to the
2184 main trunk, since these are separate development trees within Git. If you
2185 are working on both, then this would require at least two separate check
2186 outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2187 which is <literal>v_3_0_branch</literal> at the moment).
2192 <sect2 id="beforerelease">
2193 <title>Before the Release</title>
2195 The following <emphasis>must be done by one of the
2196 developers</emphasis> prior to each new release.
2201 Make sure that everybody who has worked on the code in the last
2202 couple of days has had a chance to yell <quote>no!</quote> in case
2203 they have pending changes/fixes in their pipelines. Announce the
2204 freeze so that nobody will interfere with last minute changes.
2209 Update the code status (CODE_STATUS="xxx") in configure.in to one of
2210 "alpha", "beta" or "stable".
2215 Rebuild configure and GNUMakefile to make sure the updated values are being used.
2219 $ autoheader && autoconf # rebuild configure
2220 $ ./configure # rebuild GNUmakefile
2225 <command>make dok-release</command> to update the sgml documentation source files.
2230 If action file processing has changed and is not backward-compatible,
2231 make sure the "for-privoxy-version=x.y.z" minimum version number in
2232 default.action.master has been updated:
2236 #############################################################################
2237 #MASTER# COMMENT: The minimum Privoxy version:
2238 for-privoxy-version=3.0.11
2243 Create the change log:
2248 $ git log [last release tag]..HEAD > /tmp/log
2249 # get the commit log since the last release
2250 $ utils/makeChangeLog /tmp/log > /tmp/change.log
2251 # reformat the commit log
2254 Edit <filename>/tmp/change.log</filename> to remove trivial
2255 changes and group the changes under general headings like:
2259 - Action file improvements:
2260 - Filter file improvements:
2261 - General improvements:
2262 - Documentation improvements:
2263 - Build system improvements:
2265 - Privoxy-Log-Parser:
2266 - Privoxy-Regression-Test:
2269 Add the contents of <filename>/tmp/change.log</filename> to the
2270 start of <filename>ChangeLog</filename> and re-create
2271 <filename>doc/source/changelog.sgml</filename>:
2274 $ utils/changelog2doc.pl /tmp/change.log >| doc/source/changelog.sgml
2279 All developers should look at the <filename>ChangeLog</filename> and
2280 make sure noteworthy changes are referenced.
2285 All documentation should be rebuilt:
2293 Finished docs should be then be committed to Git (for those
2294 without the ability to build these). Some docs may require
2295 rather obscure processing tools. <filename>config</filename>,
2296 the man page (and the html version of the man page)
2297 fall in this category. README, the man page, AUTHORS, and config
2298 should all also be committed to Git for other packagers. The
2299 formal docs should be uploaded to the webserver. See the section
2300 <ulink url="webserver-update.html">"Updating the webserver"</ulink>
2301 in this manual for details.
2306 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2311 The <citetitle>User Manual</citetitle> is also used for context
2312 sensitive help for the CGI editor. This is version sensitive, so that
2313 the user will get appropriate help for his/her release. So with
2314 each release a fresh version should be uploaded to the webserver
2315 (this is in addition to the main <citetitle>User Manual</citetitle>
2316 link from the main page since we need to keep manuals for various
2317 versions available). The CGI pages will link to something like
2318 <literal>https://www.privoxy.org/$(VERSION)/user-manual/</literal>. This
2319 will need to be updated for each new release. There is no Makefile
2320 target for this at this time!!! It needs to be done manually.
2325 Tag all files in Git with the version number with
2326 <quote><command>git tag v_X_Y_Z</command></quote>.
2327 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2332 On the webserver, copy the user manual to a new top-level directory
2333 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2334 pages, which have the version as a prefix, will go into the right version of the manual.
2335 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2336 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2337 <filename>.</filename> (i.e. dot).
2343 <sect2 id="therelease">
2344 <title>Building and Releasing the Packages</title>
2346 Now the individual packages can be built and released. Note that for
2347 GPL reasons the first package to be released is always the source tarball.
2351 For <emphasis>all</emphasis> types of packages, including the source tarball,
2352 <emphasis>you must make sure that you build from clean sources by exporting
2353 the right version from Git into an empty directory</emphasis> (just press return when
2354 asked for a password):
2358 mkdir dist # delete or choose different name if it already exists
2360 git clone https://www.privoxy.org/git/privoxy.git
2362 git checkout v_X_Y_Z
2366 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2367 version information after export from Git. This is to make sure that
2368 all release packages, and with them, all future bug reports, are based
2369 on exactly the same code.
2374 Every significant release of Privoxy has included at least one
2375 package that either had incorrect versions of files, missing files,
2376 or incidental leftovers from a previous build process that gave
2377 unknown numbers of users headaches to try to figure out what was
2378 wrong. PLEASE, make sure you are using pristene sources, and are
2379 following the prescribed process!
2384 Please find additional instructions for the source tarball and the
2385 individual platform dependent binary packages below. And details
2386 on the Sourceforge release process below that.
2389 <sect3 id="pack-guidelines">
2390 <title>Note on Privoxy Packaging</title>
2392 Please keep these general guidelines in mind when putting together
2393 your package. These apply to <emphasis>all</emphasis> platforms!
2398 <application>Privoxy</application> <emphasis>requires</emphasis>
2399 write access to: all <filename>*.action</filename> files, all
2400 logfiles, and the <filename>trust</filename> file. You will
2401 need to determine the best way to do this for your platform.
2406 Please include up to date documentation. At a bare minimum:
2410 <filename>LICENSE</filename> (top-level directory)
2415 <filename>README</filename> (top-level directory)
2420 <filename>AUTHORS</filename> (top-level directory)
2425 <filename>man page</filename> (top-level directory, Unix-like
2431 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2436 <filename>FAQ</filename> (doc/webserver/faq/)
2440 Also suggested: <filename>Developer Manual</filename>
2441 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2442 (top-level directory). <filename>FAQ</filename> and the manuals are
2443 HTML docs. There are also text versions in
2444 <filename>doc/text/</filename> which could conceivably also be
2448 The documentation has been designed such that the manuals are linked
2449 to each other from parallel directories, and should be packaged
2450 that way. <filename>privoxy-index.html</filename> can also be
2451 included and can serve as a focal point for docs and other links of
2452 interest (and possibly renamed to <filename>index.html</filename>).
2453 This should be one level up from the manuals. There is a link also
2454 on this page to an HTMLized version of the man page. To avoid 404 for
2455 this, it is in Git as
2456 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2457 and should be included along with the manuals. There is also a
2458 css stylesheets that can be included for better presentation:
2459 <filename>p_doc.css</filename>. This should be in the same directory
2460 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2461 the manual directories).
2466 <filename>user.action</filename> and <filename>user.filter</filename>
2467 are designed for local preferences. Make sure these do not get overwritten!
2468 <filename>config</filename> should not be overwritten either. This
2469 has especially important configuration data in it.
2470 <filename>trust</filename> should be left in tact as well.
2475 Other configuration files (<filename>default.action</filename> and
2476 <filename>default.filter</filename>) should be installed as the new
2477 defaults, but all previously installed configuration files should be
2478 preserved as backups. This is just good manners :-) These files are
2479 likely to change between releases and contain important new features
2485 Please check platform specific notes in this doc, if you haven't
2486 done <quote>Privoxy</quote> packaging before for other platform
2487 specific issues. Conversely, please add any notes that you know
2488 are important for your platform (or contact one of the doc
2489 maintainers to do this if you can't).
2494 Packagers should do a <quote>clean</quote> install of their
2495 package after building it. So any previous installs should be
2496 removed first to ensure the integrity of the newly built package.
2497 Then run the package for a while to make sure there are no
2498 obvious problems, before uploading.
2506 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2508 First, <emphasis>make sure that you have freshly exported the right
2509 version into an empty directory</emphasis>. (See "Building and releasing
2510 packages" above). Then run:
2514 autoheader && autoconf && ./configure
2523 To upload the package to Sourceforge, simply issue
2529 Go to the displayed URL and release the file publicly on Sourceforge.
2530 For the change log field, use the relevant section of the
2531 <filename>ChangeLog</filename> file.
2535 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2537 In following text, replace <replaceable class="parameter">dist</replaceable>
2538 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2541 First, <emphasis>make sure that you have freshly exported the right
2542 version into an empty directory</emphasis>. (See "Building and releasing
2546 As the only exception to not changing anything after export from Git,
2547 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2548 and make sure that the version information and the RPM release number are
2549 correct. The RPM release numbers for each version start at one. Hence it must
2550 be reset to one if this is the first RPM for
2551 <replaceable class="parameter">dist</replaceable> which is built from version
2553 <ulink url="https://sourceforge.net/projects/ijbswa/files/">file
2554 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2555 release number for that version plus one.
2562 autoheader && autoconf && ./configure
2568 make <replaceable class="parameter">dist</replaceable>-dist
2571 To upload the package to Sourceforge, simply issue
2574 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2577 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2578 RPM release number as determined above.
2579 Go to the displayed URL and release the file publicly on Sourceforge.
2580 Use the release notes and change log from the source tarball package.
2584 <sect3 id="newrelease-solaris"><title>Solaris</title>
2586 Login to Sourceforge's compilefarm via ssh:
2589 ssh cf.sourceforge.net
2592 Choose the right operating system (not the Debian one).
2593 When logged in, <emphasis>make sure that you have freshly exported the right
2594 version into an empty directory</emphasis>. (See "Building and releasing
2595 packages" above). Then run:
2599 autoheader && autoconf && ./configure
2608 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2609 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2610 to manually upload the archive to Sourceforge's ftp server and release
2611 the file publicly. Use the release notes and Change Log from the
2612 source tarball package.
2616 <sect3 id="NEWRELEASE-WINDOWS"><title>Windows</title>
2617 <!-- so annoying: docbook generated ids are UPPERCASE so
2618 links to "whatever.html#idtag" DO NOT WORK!!
2619 They have to be "whatever.html#IDTAG".
2620 So be consistent and use uppercase on the definition.
2623 Note that the docbook generated files might need some hand editing,
2624 so the Windows build makefile does not rebuild the docs.
2628 First, <emphasis>make sure that you have freshly exported the right
2629 version into an empty directory</emphasis>. (See "Building and releasing
2631 <!-- XXX ??? are we still basing releases off a tarball???
2635 Then you can build the package. This is fully automated, and is
2636 controlled by <filename>windows/GNUmakefile</filename>.
2637 All you need to do is:
2644 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2645 <filename>privoxy_setup_X.Y.Z.exe</filename>, and the <filename>build</filename>
2646 directory to <filename>privoxy_X.Y.Z</filename>.
2647 Create a .zip file of the newly renamed <filename>privoxy_X.Y.Z</filename> directory,
2648 GPG sign the installer and zip file,
2651 $ gpg --armor --detach --sign <filename>privoxy_setup_X.Y.Z.exe</filename>
2652 $ gpg --armor --detach --sign <filename>privoxy_X.Y.Z.zip</filename>
2655 and upload the files to SourceForge.
2659 When releasing the package on SourceForge, use the release notes
2660 and Change Log from the source tarball package.
2664 <sect3 id="newrelease-debian"><title>Debian</title>
2666 First, <emphasis>make sure that you have freshly exported the
2667 right version into an empty directory</emphasis>. (See
2668 "Building and releasing packages" above). Then add a log
2669 entry to <filename>debian/changelog</filename>, if it is not
2670 already there, for example by running:
2673 debchange -v &p-version;-&p-status;-1 "New upstream version"
2679 dpkg-buildpackage -rfakeroot -us -uc -b
2683 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2684 which can be uploaded. To upload the package to Sourceforge, simply
2692 <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2694 First, <emphasis>make sure that you have freshly exported the right
2695 version into an empty directory</emphasis>. (See "Building and releasing
2699 There are three modules available in the CVS repository backups for use on Mac
2700 OS X, though technically only two of them generate a release (the other
2701 can be used to install from source).
2703 <sect4 id="OS-X-OSXPackageBuilder-module">
2704 <title>OSXPackageBuilder module (Documentation out of date)</title>
2706 The OSXPackageBuilder module generates OS X installer packages
2707 supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
2708 follows into a folder parallel to the exported privoxy source:
2711 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
2714 The module contains complete instructions on its usage in the file
2715 <filename>OS X Package Builder HOWTO.txt</filename>.
2718 Once the package(s) have been generated, you can then upload them
2719 directly to the Files section of the Sourceforge project in the
2720 Macintosh (OS X) folder. Each new version release of Privoxy should
2721 have a new subfolder created in which to store its files. Please
2722 ensure that the folder contains a readme file that makes it clear
2723 which package is for whichversion of OS X.
2726 <sect4 id="OS-X-osxsetup-module">
2727 <title>osxsetup module (DEPRECATED) (Documentation out of date)</title>
2729 <emphasis>This module is deprecated since the installer it generates
2730 places all Privoxy files in one folder in a non-standard location, and
2731 supports only Intel Macs running OS X 10.6 or higher.</emphasis>
2734 Check out the module from CVS as follows into a folder parallel to the
2735 exported privoxy source:
2738 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2748 This will run <filename>autoheader</filename>, <filename>autoconf</filename>
2749 and <filename>configure</filename> as well as <filename>make</filename>.
2750 Finally, it will copy over the necessary files to the ./osxsetup/files
2751 directory for further processing by <filename>PackageMaker</filename>.
2754 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
2755 modify the package name to match the release, and hit the "Create
2756 package" button. If you specify ./Privoxy.pkg as the output package
2757 name, you can then create the distributable zip file with the command:
2760 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2763 You can then upload this file directly to the Files section of the
2764 Sourceforge project in the Macintosh (OS X) folder. Each new version
2765 release of Privoxy should have a new subfolder created in which to
2767 Please ensure that the folder contains a readme file that makes it
2768 clear which version(s) of OS X the package supports.
2771 <sect4 id="OS-X-macsetup-module">
2772 <title>macsetup module (Documentation out of date)</title>
2774 The macsetup module is ideal if you wish to build and install Privoxy
2775 from source on a single machine.
2778 Check out the module from CVS as follows into a folder parallel to the
2779 exported privoxy source:
2782 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
2785 The module contains complete instructions on its usage in its
2786 <filename>README</filename> file. The end result will be the
2787 exported version of Privoxy installed on the build machine.
2792 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2794 Update the www/privoxy port and submit a diff upstream.
2795 For details see the <ulink url="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/">FreeBSD Porter's Handbook</ulink>.
2800 <sect2 id="releasing">
2801 <title>Uploading and Releasing Your Package</title>
2803 After the package is ready, it is time to upload it
2804 to SourceForge, and go through the release steps. The upload
2810 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2815 user: <literal>anonymous</literal>
2820 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2825 Or use the <command>make</command> targets as described above.
2828 Once this done go to
2829 <ulink url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118">
2830 https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2831 making sure you are logged in. Find your target platform in the
2832 second column, and click <literal>Add Release</literal>. You will
2833 then need to create a new release for your package, using the format
2834 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2838 Now just follow the prompts. Be sure to add any appropriate Release
2839 notes. You should see your freshly uploaded packages in
2840 <quote>Step 2. Add Files To This Release</quote>. Check the
2841 appropriate box(es). Remember at each step to hit the
2842 <quote>Refresh/Submit</quote> buttons! You should now see your
2843 file(s) listed in Step 3. Fill out the forms with the appropriate
2844 information for your platform, being sure to hit <quote>Update</quote>
2845 for each file. If anyone is monitoring your platform, check the
2846 <quote>email</quote> box at the very bottom to notify them of
2847 the new package. This should do it!
2850 If you have made errors, or need to make changes, you can go through
2851 essentially the same steps, but select <literal>Edit Release</literal>,
2852 instead of <literal>Add Release</literal>.
2856 <sect2 id="afterrelease">
2857 <title>After the Release</title>
2859 When all (or: most of the) packages have been uploaded and made available,
2860 send an email to the
2861 <ulink url="mailto:privoxy-announce@lists.privoxy.org">announce mailing
2862 list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2864 <ulink url="https://sourceforge.net/projects/ijbswa/files/">
2865 download location</ulink>, the release notes and the Changelog. Also, post an
2866 updated News item on the project page Sourceforge, and update the Home
2867 page and docs linked from the Home page (see below). Other news sites
2868 and release oriented sites, such as Freshmeat, should also be notified.
2871 Then update the source code for the next version to be released:
2876 Increment the version number and change the code status to "UNRELEASED"
2877 in <filename>configure.in</filename>
2882 Rebuild configure (<quote><command>autoheader && autoconf</command></quote>)
2883 and GNUMakefile (<quote><command>./configure</command></quote>)
2888 <quote><command>make dok-release</command></quote> to update the sgml documentation source files.
2893 Commit all your changes.
2902 <!-- ~~~~~ New section ~~~~~ -->
2903 <sect1 id="webserver-update"><title>Update the Webserver</title>
2905 The webserver should be updated at least with each stable release. When
2906 updating, please follow these steps to make sure that no broken links,
2907 inconsistent contents or permission problems will occur (as it has many
2908 times in the past!):
2911 If you have changed anything in the stable-branch documentation source
2918 That will generate <filename>doc/webserver/user-manual</filename>,
2919 <filename>doc/webserver/developer-manual</filename>,
2920 <filename>doc/webserver/faq</filename>,
2921 <filename>doc/webserver/index.html</filename> automatically.
2924 If you changed the manual page sources, generate
2925 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2926 by running <quote><command>make man</command></quote>. (This is
2927 a separate target due to dependencies on some obscure perl scripts
2928 [now in Git, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2931 If you want to add new files to the webserver, create them locally in
2932 the <filename>doc/webserver/*</filename> directory (or
2933 create new directories under <filename>doc/webserver</filename>).
2936 Next, commit any changes from the above steps to Git. All set?
2937 If these are docs in the stable branch, then do:
2943 This will do the upload to the SourceForge webserver (which is manually
2944 syncronized with <ulink url="https://www.privoxy.org/">www.privoxy.org</ulink>)
2945 and ensure all files and directories there are group writable.
2948 Please do <emphasis>NOT</emphasis> use any other means of transferring
2949 files to the webserver to avoid permission problems. Also, please do not
2950 upload docs from development branches or versions. The publicly posted
2951 docs should be in sync with the last official release.
2957 This program is free software; you can redistribute it
2958 and/or modify it under the terms of the GNU General
2959 Public License as published by the Free Software
2960 Foundation; either version 2 of the License, or (at
2961 your option) any later version.
2963 This program is distributed in the hope that it will
2964 be useful, but WITHOUT ANY WARRANTY; without even the
2965 implied warranty of MERCHANTABILITY or FITNESS FOR A
2966 PARTICULAR PURPOSE. See the GNU General Public
2967 License for more details.
2969 The GNU General Public License should be included with
2970 this file. If not, you can view it at
2971 http://www.gnu.org/copyleft/gpl.html
2972 or write to the Free Software Foundation, Inc., 59
2973 Temple Place - Suite 330, Boston, MA 02111-1307, USA.