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.27">
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-2018 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-2018 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 Free Software project
114 and the code is licensed under the GNU General Public License version 2.
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. Patches are best
132 submitted to the Sourceforge tracker set up for this purpose, but
133 can be sent to the list for review too.
136 You will also need to have a git package installed, which will
137 entail having ssh installed as well, 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 at the
161 <ulink url="https://privoxy.org/">Privoxy site.</ulink>
162 The Git repository URL is
163 <literal>ssh://git@git.privoxy.org:23/git/privoxy.git</literal>,
164 the central repository is called <literal>privoxy</literal>, and the
165 source branch is called <literal>master</literal>. Subfolders exist
166 within the project for target-dependent build and packaging tools, each
167 including the name of the target operating system in their name (e.g.
168 Windows, OSXPackageBuilder, debian). There is a webview of the Git
170 <ulink url="https://www.privoxy.org/gitweb/?p=privoxy.git;a=tree">
171 https://www.privoxy.org/gitweb/?p=privoxy.git;a=tree</ulink>,
172 which might help with visualizing how these pieces fit together.
176 <sect2 id="gitbranches">
177 <title>Branches</title>
179 Whilst the central repository contains only the master branch, developers
180 are of course free to create branches in their local repositories as they
181 develop features, fixes, or update the target-dependent tools. Only once
182 such changes are fully tested ought they be pushed back to the central
183 repository master branch.
187 Branches are used to fork a sub-development path from the main trunk.
188 Within the <literal>current</literal> module where the sources are, there
189 is always at least one <quote>branch</quote> from the main trunk
190 devoted to a stable release series. The main trunk is where active
191 development takes place for the next stable series (e.g. 3.2.x).
192 So just prior to each stable series (e.g. 3.0.x), a branch is created
193 just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
194 Once the initial stable release of any stable branch has taken place,
195 this branch is <emphasis>only used for bugfixes</emphasis>, which have
196 had prior testing before being committed to Git. (See <link
197 linkend="versionnumbers">Version Numbers</link> below for details on
202 At one time there were two distinct branches: stable and unstable. The
203 more drastic changes were to be in the unstable branch. These branches
204 have now been merged to minimize time and effort of maintaining two
209 This will result in at least two active branches, which means there may
210 be occasions that require the same (or similar) item to be
211 checked into to two different places (assuming its a bugfix and needs
212 fixing in both the stable and unstable trees). This also means that in
213 order to have access to both trees, both will have to be checked out
214 separately. Use the <literal>cvs -r</literal> flag to check out a
215 branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
220 <sect2 id="gitcommit"><title>Git Commit Guidelines</title>
222 The source tree is the heart of every software project. Every effort must
223 be made to ensure that it is readable, compilable and consistent at all
224 times. <!-- There are differing guidelines for the stable branch and the
225 main development trunk, and --> We expect anyone with Git access to strictly
226 adhere to the following guidelines:
230 Basic Guidelines, for all branches:
234 Please don't commit even
235 a small change without testing it thoroughly first. When we're
236 close to a public release, ask a fellow developer to review your
240 Your commit message should give a concise overview of <emphasis>what you
241 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
242 Just check previous messages for good examples.
245 Don't use the same message on multiple files, unless it equally applies to
249 If your changes span multiple files, and the code won't recompile unless
250 all changes are committed (e.g. when changing the signature of a function),
251 then commit all files one after another, without long delays in between.
252 If necessary, prepare the commit messages in advance.
255 Before changing things on Git, make sure that your changes are in line
256 with the team's general consensus on what should be done.
260 Note that near a major public release, we get more cautious.
261 There is always the possibility to submit a patch to the <ulink
262 url="https://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
263 tracker</ulink> instead.
270 Stable branches are handled with more care, especially after the
271 initial *.*.0 release, and we are just in bugfix mode. In addition to
272 the above, the below applies only to the stable branch (currently the
273 <literal>v_3_0_branch</literal> branch):
280 Do not commit <emphasis>anything</emphasis> unless your proposed
281 changes have been well tested first, preferably by other members of the
282 project, or have prior approval of the project leaders or consensus
288 Where possible, bugfixes and changes should be tested in the main
289 development trunk first. There may be occasions where this is not
295 Alternately, proposed changes can be submitted as patches output by
296 <literal>git format-patch</literal> to the privoxy-devel mailing list
297 or alternatively to the patch tracker on Sourceforge:
298 <ulink url="https://sourceforge.net/tracker/?group_id=11118&atid=311118">
299 https://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
300 Then ask for peer review.
305 Do not even think about anything except bugfixes. No new features!
316 <!-- ~~~~~ New section ~~~~~ -->
317 <sect1 id="documentation"><title>Documentation Guidelines</title>
319 All formal documents are maintained in Docbook SGML and located in the
320 <computeroutput>doc/source/*</computeroutput> directory. You will need
321 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
322 DTD's and the Docbook modular stylesheets (or comparable alternatives),
323 and either <application>jade</application> or
324 <application>openjade</application> (recommended) installed in order to
325 build docs from source. Currently there is <ulink
326 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
327 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
328 course this, the <citetitle>developer-manual</citetitle> in this format.
329 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
330 <citetitle>INSTALL</citetitle>,
331 <citetitle>privoxy.1</citetitle> (man page), and
332 <citetitle>config</citetitle> files are also now maintained as Docbook
333 SGML. These files, when built, in the top-level source directory are
334 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
335 variation on this file, <filename>privoxy-index.html</filename>,
336 meant for inclusion with doc packages), are maintained as SGML as well.
337 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
338 contact someone involved in the documentation.
341 <filename>config</filename> requires some special handling. The reason it
342 is maintained this way is so that the extensive comments in the file
343 mirror those in <citetitle>user-manual</citetitle>. But the conversion
344 process requires going from SGML to HTML to text to special formatting
345 required for the embedded comments. Some of this does not survive so
346 well. Especially some of the examples that are longer than 80 characters.
347 The build process for this file outputs to <filename>config.new</filename>,
348 which should be reviewed for errors and mis-formatting. Once satisfied
349 that it is correct, then it should be hand copied to
350 <filename>config</filename>.
353 Other, less formal documents (e.g. <filename>LICENSE</filename>) are
354 maintained as plain text files in the top-level source directory.
357 Packagers are encouraged to include this documentation. For those without
358 the ability to build the docs locally, text versions of each are kept in
359 Git. HTML versions are also being kept in Git under
360 <filename>doc/webserver/*</filename>.
363 Formal documents are built with the Makefile targets of
364 <computeroutput>make dok</computeroutput>.
365 The build process uses the document SGML sources in
366 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
367 <computeroutput>doc/text/</computeroutput> and to update all HTML
368 documents in <computeroutput>doc/webserver/</computeroutput>.
371 Documentation writers should please make sure documents build
372 successfully before committing to Git, if possible.
375 How do you update the webserver (i.e. the pages on privoxy.org)?
378 <orderedlist numeration="arabic">
380 First, build the docs by running <computeroutput>make
381 dok</computeroutput>.
384 Run <computeroutput>make webserver</computeroutput> which copies all
385 files from <computeroutput>doc/webserver</computeroutput> to the
386 sourceforge webserver via scp.
391 Finished docs should be occasionally submitted to Git
392 (<filename>doc/webserver/*/*.html</filename>) so that those without
393 the ability to build them locally, have access to them if needed.
394 This is especially important just prior to a new release! Please
395 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
396 other release specific data in <filename>configure.in</filename> has been
397 updated (this is done just prior to a new release).
400 <!-- ~~~~~ New section ~~~~~ -->
402 <title>Quickstart to Docbook and SGML</title>
404 If you are not familiar with SGML, it is a markup language similar to HTML.
405 Actually, not a mark up language per se, but a language used to define
406 markup languages. In fact, HTML is an SGML application. Both will use
407 <quote>tags</quote> to format text and other content. SGML tags can be much
408 more varied, and flexible, but do much of the same kinds of things. The tags,
409 or <quote>elements</quote>, are definable in SGML. There is no set
410 <quote>standards</quote>. Since we are using
411 <application>Docbook</application>, our tags are those that are defined by
412 <application>Docbook</application>. Much of how the finish document is
413 rendered is determined by the <quote>stylesheets</quote>.
414 The stylesheets determine how each tag gets translated to HTML, or other
419 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
420 will likely generate errors. Example: <literal><title>My
421 Title</title></literal>. They are also case-insensitive, but we
422 strongly suggest using all lower case. This keeps compatibility with
423 [Docbook] <application>XML</application>.
427 Our documents use <quote>sections</quote> for the most part. Sections
428 will be processed into HTML headers (e.g. <literal>h1</literal> for
429 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
430 will use these to also generate the Table of Contents for each doc. Our
431 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
432 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
433 entries, but <literal>sect4</literal> will not. Each section requires
434 a <literal><title></literal> element, and at least one
435 <literal><para></literal>. There is a limit of five section
436 levels in Docbook, but generally three should be sufficient for our
441 Some common elements that you likely will use:
446 <emphasis><para></para></emphasis>, paragraph delimiter. Most
447 text needs to be within paragraph elements (there are some exceptions).
450 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
454 <emphasis><filename></filename></emphasis>, files and directories.
457 <emphasis><command></command></emphasis>, command examples.
460 <emphasis><literallayout></literallayout></emphasis>, like
461 <literal><pre></literal>, more or less.
464 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
467 <emphasis><listitem></listitem></emphasis>, member of the above.
470 <emphasis><screen></screen></emphasis>, screen output, implies
471 <literal><literallayout></literal>.
474 <emphasis><ulink url="example.com"></ulink></emphasis>, like
475 HTML <literal><a></literal> tag.
478 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
483 Look at any of the existing docs for examples of all these and more.
488 <!-- <quote><ulink url="http://opensource.bureau-cornavin.com/crash-course/index.html">
489 domain no longer exists so link to the wayback archive -->
490 <quote><ulink url="https://web.archive.org/web/20160315230758/http://opensource.bureau-cornavin.com/crash-course/index.html">
491 Writing Documentation Using DocBook - A Crash Course</ulink></quote> useful.
495 <!-- ~~~~~ New section ~~~~~ -->
496 <sect2 id="docstyle">
497 <title><application>Privoxy</application> Documentation Style</title>
499 It will be easier if everyone follows a similar writing style. This
500 just makes it easier to read what someone else has written if it
501 is all done in a similar fashion.
509 All tags should be lower case.
514 Tags delimiting a <emphasis>block</emphasis> of text (even small
515 blocks) should be on their own line. Like:
523 Tags marking individual words, or few words, should be in-line:
526 Just to <emphasis>emphasize</emphasis>, some text goes here.
531 Tags should be nested and step indented for block text like: (except
539 Some text goes here in our list example.
542 </itemizedlist>
546 This makes it easier to find the text amongst the tags ;-)
551 Use white space to separate logical divisions within a document,
552 like between sections. Running everything together consistently
553 makes it harder to read and work on.
558 Do not hesitate to make comments. Comments can either use the
559 <comment> element, or the <!-- --> style comment
560 familiar from HTML. (Note in Docbook v4.x <comment> is
561 replaced by <remark>.)
566 We have an international audience. Refrain from slang, or English
567 idiosyncrasies (too many to list :). Humor also does not translate
573 Try to keep overall line lengths in source files to 80 characters or less
574 for obvious reasons. This is not always possible, with lengthy URLs for
580 Our documents are available in differing formats. Right now, they
581 are just plain text and/or HTML, but others are always a
582 future possibility. Be careful with URLs (<ulink>), and avoid
586 My favorite site is <ulink url="http://example.com">here</ulink>.
589 This will render as <quote>My favorite site is here</quote>, which is
590 not real helpful in a text doc. Better like this:
593 My favorite site is <ulink url="http://example.com">example.com</ulink>.
598 All documents should be spell checked occasionally.
599 <application>aspell</application> can check SGML with the
600 <literal>-H</literal> option. (<application>ispell</application> I think
610 <!-- ~~~~~ New section ~~~~~ -->
612 <sect2><title>Privoxy Custom Entities</title>
614 <application>Privoxy</application> documentation is using
615 a number of customized <quote>entities</quote> to facilitate
616 documentation maintenance.
619 We are using a set of <quote>boilerplate</quote> files with generic text,
620 that is used by multiple docs. This way we can write something once, and use
621 it repeatedly without having to re-write the same content over and over again.
622 If editing such a file, keep in mind that it should be
623 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
624 contexts without additional modifications.
627 We are also using what <application>Docbook</application> calls
628 <quote>internal entities</quote>. These are like variables in
629 programming. Well, sort of. For instance, we have the
630 <literal>p-version</literal> entity that contains the current
631 <application>Privoxy</application> version string. You are strongly
632 encouraged to use these where possible. Some of these obviously
633 require re-setting with each release (done by the Makefile). A sampling of
634 custom entities are listed below. See any of the main docs for examples.
640 Re- <quote>boilerplate</quote> text entities are defined like:
643 <literal><!entity supported SYSTEM "supported.sgml"></literal>
646 In this example, the contents of the file,
647 <filename>supported.sgml</filename> is available for inclusion anywhere
648 in the doc. To make this happen, just reference the now defined
649 entity: <literal>&supported;</literal> (starts with an ampersand
650 and ends with a semi-colon), and the contents will be dumped into
651 the finished doc at that point.
656 Commonly used <quote>internal entities</quote>:
660 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
661 version string, e.g. <quote>&p-version;</quote>.
664 <emphasis>p-status</emphasis>: the project status, either
665 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
668 <emphasis>p-not-stable</emphasis>: use to conditionally include
669 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
672 <emphasis>p-stable</emphasis>: just the opposite.
675 <emphasis>p-text</emphasis>: this doc is only generated as text.
681 There are others in various places that are defined for a specific
682 purpose. Read the source!
689 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
690 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
692 <!-- ~~~~~ New section ~~~~~ -->
693 <sect1 id="coding"><title>Coding Guidelines</title>
695 <sect2 id="s1"><title>Introduction</title>
697 <para>This set of standards is designed to make our lives easier. It is
698 developed with the simple goal of helping us keep the "new and improved
699 <application>Privoxy</application>" consistent and reliable. Thus making
700 maintenance easier and increasing chances of success of the
703 <para>And that of course comes back to us as individuals. If we can
704 increase our development and product efficiencies then we can solve more
705 of the request for changes/improvements and in general feel good about
706 ourselves. ;-></para>
710 <sect2 id="s2"><title>Using Comments</title>
713 <sect3 id="s3"><title>Comment, Comment, Comment</title>
715 <para><emphasis>Explanation:</emphasis></para>
717 <para>Comment as much as possible without commenting the obvious.
718 For example do not comment "variable_a is equal to variable_b".
719 Instead explain why variable_a should be equal to the variable_b.
720 Just because a person can read code does not mean they will
721 understand why or what is being done. A reader may spend a lot
722 more time figuring out what is going on when a simple comment
723 or explanation would have prevented the extra research. Please
724 help your fellow Privoxy developers out!</para>
726 <para>The comments will also help justify the intent of the code.
727 If the comment describes something different than what the code
728 is doing then maybe a programming error is occurring.</para>
730 <para><emphasis>Example:</emphasis></para>
732 /* if page size greater than 1k ... */
733 if (page_length() > 1024)
735 ... "block" the page up ...
738 /* if page size is small, send it in blocks */
739 if (page_length() > 1024)
741 ... "block" the page up ...
744 This demonstrates 2 cases of "what not to do". The first is a
745 "syntax comment". The second is a comment that does not fit what
746 is actually being done.
752 <sect3 id="s4"><title>Use blocks for comments</title>
754 <para><emphasis>Explanation:</emphasis></para>
756 <para>Comments can help or they can clutter. They help when they
757 are differentiated from the code they describe. One line
758 comments do not offer effective separation between the comment
759 and the code. Block identifiers do, by surrounding the code
760 with a clear, definable pattern.</para>
762 <para><emphasis>Example:</emphasis></para>
764 /*********************************************************************
765 * This will stand out clearly in your code!
766 *********************************************************************/
767 if (this_variable == that_variable)
769 do_something_very_important();
773 /* unfortunately, this may not */
774 if (this_variable == that_variable)
776 do_something_very_important();
780 if (this_variable == that_variable) /* this may not either */
782 do_something_very_important();
785 <para><emphasis>Exception:</emphasis></para>
787 <para>If you are trying to add a small logic comment and do not
788 wish to "disrupt" the flow of the code, feel free to use a 1
789 line comment which is NOT on the same line as the code.</para>
795 <sect3 id="s5"><title>Keep Comments on their own line</title>
797 <para><emphasis>Explanation:</emphasis></para>
799 <para>It goes back to the question of readability. If the comment
800 is on the same line as the code it will be harder to read than
801 the comment that is on its own line.</para>
803 <para>There are three exceptions to this rule, which should be
804 violated freely and often: during the definition of variables,
805 at the end of closing braces, when used to comment
808 <para><emphasis>Example:</emphasis></para>
810 /*********************************************************************
811 * This will stand out clearly in your code,
812 * But the second example won't.
813 *********************************************************************/
814 if (this_variable == this_variable)
816 do_something_very_important();
819 if (this_variable == this_variable) /*can you see me?*/
821 do_something_very_important(); /*not easily*/
825 /*********************************************************************
826 * But, the encouraged exceptions:
827 *********************************************************************/
828 int urls_read = 0; /* # of urls read + rejected */
829 int urls_rejected = 0; /* # of urls rejected */
833 do_something_very_important();
837 short do_something_very_important(
838 short firstparam, /* represents something */
839 short nextparam /* represents something else */ )
843 } /* -END- do_something_very_important */
848 <sect3 id="s6"><title>Comment each logical step</title>
850 <para><emphasis>Explanation:</emphasis></para>
852 <para>Logical steps should be commented to help others follow the
853 intent of the written code and comments will make the code more
856 <para>If you have 25 lines of code without a comment, you should
857 probably go back into it to see where you forgot to put
860 <para>Most "for", "while", "do", etc... loops _probably_ need a
861 comment. After all, these are usually major logic
868 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
870 <para><emphasis>Explanation:</emphasis></para>
872 <para>A reader of the code should be able to look at the comments
873 just prior to the beginning of a function and discern the
874 reason for its existence and the consequences of using it. The
875 reader should not have to read through the code to determine if
876 a given function is safe for a desired use. The proper
877 information thoroughly presented at the introduction of a
878 function not only saves time for subsequent maintenance or
879 debugging, it more importantly aids in code reuse by allowing a
880 user to determine the safety and applicability of any function
881 for the problem at hand. As a result of such benefits, all
882 functions should contain the information presented in the
883 addendum section of this document.</para>
889 <sect3 id="s8"><title>Comment at the end of braces if the
890 content is more than one screen length</title>
892 <para><emphasis>Explanation:</emphasis></para>
894 <para>Each closing brace should be followed on the same line by a
895 comment that describes the origination of the brace if the
896 original brace is off of the screen, or otherwise far away from
897 the closing brace. This will simplify the debugging,
898 maintenance, and readability of the code.</para>
900 <para>As a suggestion , use the following flags to make the
901 comment and its brace more readable:</para>
903 <para>use following a closing brace: } /* -END- if() or while ()
906 <para><emphasis>Example:</emphasis></para>
910 do_something_very_important();
911 ...some long list of commands...
912 } /* -END- if x is 1 */
918 do_something_very_important();
919 ...some long list of commands...
920 } /* -END- if (1 == X) */
926 <sect2 id="s9"><title>Naming Conventions</title>
930 <sect3 id="s10"><title>Variable Names</title>
932 <para><emphasis>Explanation:</emphasis></para>
934 <para>Use all lowercase, and separate words via an underscore
935 ('_'). Do not start an identifier with an underscore. (ANSI C
936 reserves these for use by the compiler and system headers.) Do
937 not use identifiers which are reserved in ANSI C++. (E.g.
938 template, class, true, false, ...). This is in case we ever
939 decide to port Privoxy to C++.</para>
941 <para><emphasis>Example:</emphasis></para>
943 int ms_iis5_hack = 0;</programlisting>
945 <para><emphasis>Instead of:</emphasis></para>
948 int msiis5hack = 0; int msIis5Hack = 0;
955 <sect3 id="s11"><title>Function Names</title>
957 <para><emphasis>Explanation:</emphasis></para>
959 <para>Use all lowercase, and separate words via an underscore
960 ('_'). Do not start an identifier with an underscore. (ANSI C
961 reserves these for use by the compiler and system headers.) Do
962 not use identifiers which are reserved in ANSI C++. (E.g.
963 template, class, true, false, ...). This is in case we ever
964 decide to port Privoxy to C++.</para>
966 <para><emphasis>Example:</emphasis></para>
968 int load_some_file(struct client_state *csp)</programlisting>
970 <para><emphasis>Instead of:</emphasis></para>
973 int loadsomefile(struct client_state *csp)
974 int loadSomeFile(struct client_state *csp)
981 <sect3 id="s12"><title>Header file prototypes</title>
983 <para><emphasis>Explanation:</emphasis></para>
985 <para>Use a descriptive parameter name in the function prototype
986 in header files. Use the same parameter name in the header file
987 that you use in the c file.</para>
989 <para><emphasis>Example:</emphasis></para>
991 (.h) extern int load_aclfile(struct client_state *csp);
992 (.c) int load_aclfile(struct client_state *csp)</programlisting>
994 <para><emphasis>Instead of:</emphasis></para>
996 (.h) extern int load_aclfile(struct client_state *); or
997 (.h) extern int load_aclfile();
998 (.c) int load_aclfile(struct client_state *csp)
1005 <sect3 id="s13"><title>Enumerations, and #defines</title>
1007 <para><emphasis>Explanation:</emphasis></para>
1009 <para>Use all capital letters, with underscores between words. Do
1010 not start an identifier with an underscore. (ANSI C reserves
1011 these for use by the compiler and system headers.)</para>
1013 <para><emphasis>Example:</emphasis></para>
1015 (enumeration) : enum Boolean {FALSE, TRUE};
1016 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1018 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1019 that toggle a feature in the preprocessor: FEATURE_>, where
1020 > is a short (preferably 1 or 2 word) description.</para>
1022 <para><emphasis>Example:</emphasis></para>
1024 #define FEATURE_FORCE 1
1026 #ifdef FEATURE_FORCE
1027 #define FORCE_PREFIX blah
1028 #endif /* def FEATURE_FORCE */
1033 <sect3 id="s14"><title>Constants</title>
1035 <para><emphasis>Explanation:</emphasis></para>
1037 <para>Spell common words out entirely (do not remove vowels).</para>
1039 <para>Use only widely-known domain acronyms and abbreviations.
1040 Capitalize all letters of an acronym.</para>
1042 <para>Use underscore (_) to separate adjacent acronyms and
1043 abbreviations. Never terminate a name with an underscore.</para>
1045 <para><emphasis>Example:</emphasis></para>
1047 #define USE_IMAGE_LIST 1</programlisting>
1049 <para><emphasis>Instead of:</emphasis></para>
1052 #define USE_IMG_LST 1 or
1053 #define _USE_IMAGE_LIST 1 or
1054 #define USE_IMAGE_LIST_ 1 or
1055 #define use_image_list 1 or
1056 #define UseImageList 1
1065 <sect2 id="s15"><title>Using Space</title>
1069 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1071 <para><emphasis>Explanation:</emphasis></para>
1073 <para>The brace needs to be on a line all by itself, not at the
1074 end of the statement. Curly braces should line up with the
1075 construct that they're associated with. This practice makes it
1076 easier to identify the opening and closing braces for a
1079 <para><emphasis>Example:</emphasis></para>
1086 <para><emphasis>Instead of:</emphasis></para>
1088 <para>if (this == that) { ... }</para>
1092 <para>if (this == that) { ... }</para>
1094 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1095 inside a loop, and it is trivial, i.e. it tests for a
1096 condition that is obvious from the purpose of the block,
1097 one-liners as above may optically preserve the loop structure
1098 and make it easier to read.</para>
1100 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1102 <para><emphasis>Example exception:</emphasis></para>
1104 while (more lines are read)
1106 /* Please document what is/is not a comment line here */
1107 if (it's a comment) continue;
1115 <sect3 id="s17"><title>ALL control statements should have a
1118 <para><emphasis>Explanation:</emphasis></para>
1120 <para>Using braces to make a block will make your code more
1121 readable and less prone to error. All control statements should
1122 have a block defined.</para>
1124 <para><emphasis>Example:</emphasis></para>
1129 do_something_else();
1132 <para><emphasis>Instead of:</emphasis></para>
1134 <para>if (this == that) do_something(); do_something_else();</para>
1138 <para>if (this == that) do_something();</para>
1140 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1141 in a manner other than that which the developer desired (per
1142 indentation). Using code braces would have prevented this
1143 "feature". The "explanation" and "exception" from the point
1144 above also applies.</para>
1150 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1153 <para><emphasis>Example:</emphasis></para>
1155 structure->flag = (condition);</programlisting>
1157 <para><emphasis>Instead of:</emphasis></para>
1159 <para>if (condition) { structure->flag = 1; } else {
1160 structure->flag = 0; }</para>
1162 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1163 is wordy and inefficient. Please assume that any developer new
1164 to the project has at least a "good" knowledge of C/C++. (Hope
1165 I do not offend by that last comment ... 8-)</para>
1171 <sect3 id="s19"><title>Use white space freely because it is
1174 <para><emphasis>Explanation:</emphasis></para>
1176 <para>Make it readable. The notable exception to using white space
1177 freely is listed in the next guideline.</para>
1179 <para><emphasis>Example:</emphasis></para>
1181 int first_value = 0;
1183 int another_value = 0;
1184 int this_variable = 0;
1189 <sect3 id="s20"><title>Don't use white space around structure
1192 <para><emphasis>Explanation:</emphasis></para>
1194 <para>- structure pointer operator ( "->" ) - member operator (
1195 "." ) - functions and parentheses</para>
1197 <para>It is a general coding practice to put pointers, references,
1198 and function parentheses next to names. With spaces, the
1199 connection between the object and variable/function name is not
1202 <para><emphasis>Example:</emphasis></para>
1206 function_name();</programlisting>
1208 <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
1209 function_name ();</para>
1215 <sect3 id="s21"><title>Make the last brace of a function stand
1218 <para><emphasis>Example:</emphasis></para>
1220 int function1( ... )
1225 } /* -END- function1 */
1228 int function2( ... )
1230 } /* -END- function2 */
1233 <para><emphasis>Instead of:</emphasis></para>
1235 <para>int function1( ... ) { ...code... return(ret_code); } int
1236 function2( ... ) { }</para>
1238 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1239 lines afterward. This makes the end of function standout to
1240 the most casual viewer. Although function comments help
1241 separate functions, this is still a good coding practice. In
1242 fact, I follow these rules when using blocks in "for", "while",
1243 "do" loops, and long if {} statements too. After all whitespace
1246 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1247 lines. Enforced is the end of function comments.</para>
1253 <sect3 id="s22"><title>Use 3 character indentions</title>
1255 <para><emphasis>Explanation:</emphasis></para>
1257 <para>If some use 8 character TABs and some use 3 character TABs,
1258 the code can look *very* ragged. So use 3 character indentions
1259 only. If you like to use TABs, pass your code through a filter
1260 such as "expand -t3" before checking in your code.</para>
1262 <para><emphasis>Example:</emphasis></para>
1264 static const char * const url_code_map[256] =
1270 int function1( ... )
1278 return HOW_DID_YOU_GET_HERE;
1281 return NEVER_GETS_HERE;
1290 <sect2 id="s23"><title>Initializing</title>
1294 <sect3 id="s24"><title>Initialize all variables</title>
1296 <para><emphasis>Explanation:</emphasis></para>
1298 <para>Do not assume that the variables declared will not be used
1299 until after they have been assigned a value somewhere else in
1300 the code. Remove the chance of accidentally using an unassigned
1303 <para><emphasis>Example:</emphasis></para>
1307 struct *ptr = NULL;</programlisting>
1309 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1310 message says you are trying to access memory address 00000000
1311 and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
1312 array_ptr[0].</para>
1314 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1315 variable is assigned a value "shortly after" declaration.</para>
1321 <sect2 id="s25"><title>Functions</title>
1325 <sect3 id="s26"><title>Name functions that return a boolean as a
1328 <para><emphasis>Explanation:</emphasis></para>
1330 <para>Value should be phrased as a question that would logically
1331 be answered as a true or false statement</para>
1333 <para><emphasis>Example:</emphasis></para>
1335 should_we_block_this();
1336 contains_an_image();
1337 is_web_page_blank();
1342 <sect3 id="s27"><title>Always specify a return type for a
1345 <para><emphasis>Explanation:</emphasis></para>
1347 <para>The default return for a function is an int. To avoid
1348 ambiguity, create a return for a function when the return has a
1349 purpose, and create a void return type if the function does not
1350 need to return anything.</para>
1356 <sect3 id="s28"><title>Minimize function calls when iterating by
1357 using variables</title>
1359 <para><emphasis>Explanation:</emphasis></para>
1361 <para>It is easy to write the following code, and a clear argument
1362 can be made that the code is easy to understand:</para>
1364 <para><emphasis>Example:</emphasis></para>
1366 for (size_t cnt = 0; cnt < block_list_length(); cnt++)
1371 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1372 each and every iteration. This increases the overhead in the
1373 program, because the compiler has to look up the function each
1374 time, call it, and return a value. Depending on what occurs in
1375 the block_list_length() call, it might even be creating and
1376 destroying structures with each iteration, even though in each
1377 case it is comparing "cnt" to the same value, over and over.
1378 Remember too - even a call to block_list_length() is a function
1379 call, with the same overhead.</para>
1381 <para>Instead of using a function call during the iterations,
1382 assign the value to a variable, and evaluate using the
1385 <para><emphasis>Example:</emphasis></para>
1387 size_t len = block_list_length();
1389 for (size_t cnt = 0; cnt < len; cnt++)
1394 <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
1395 *may* change or could *potentially* change, then you must code the
1396 function call in the for/while loop.</para>
1402 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1404 <para><emphasis>Explanation:</emphasis></para>
1406 <para>This allows a developer to define a const pointer and call
1407 your function. If your function does not have the const
1408 keyword, we may not be able to use your function. Consider
1409 strcmp, if it were defined as: extern int strcmp(char *s1,
1412 <para>I could then not use it to compare argv's in main: int
1413 main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
1416 <para>Both these pointers are *const*! If the c runtime library
1417 maintainers do it, we should too.</para>
1423 <sect3 id="s30"><title>Pass and Return by Value</title>
1425 <para><emphasis>Explanation:</emphasis></para>
1427 <para>Most structures cannot fit onto a normal stack entry (i.e.
1428 they are not 4 bytes or less). Aka, a function declaration
1429 like: int load_aclfile(struct client_state csp)</para>
1431 <para>would not work. So, to be consistent, we should declare all
1432 prototypes with "pass by value": int load_aclfile(struct
1433 client_state *csp)</para>
1439 <sect3 id="s31"><title>Names of include files</title>
1441 <para><emphasis>Explanation:</emphasis></para>
1443 <para>Your include statements should contain the file name without
1444 a path. The path should be listed in the Makefile, using -I as
1445 processor directive to search the indicated paths. An exception
1446 to this would be for some proprietary software that utilizes a
1447 partial path to distinguish their header files from system or
1448 other header files.</para>
1450 <para><emphasis>Example:</emphasis></para>
1452 #include <iostream.h> /* This is not a local include */
1453 #include "config.h" /* This IS a local include */
1456 <para><emphasis>Exception:</emphasis></para>
1459 /* This is not a local include, but requires a path element. */
1460 #include <sys/fileName.h>
1463 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1464 without a _very_ good reason. This duplicates the #include
1465 "file.h" behavior.</para>
1471 <sect3 id="s32"><title>Provide multiple inclusion
1474 <para><emphasis>Explanation:</emphasis></para>
1476 <para>Prevents compiler and linker errors resulting from
1477 redefinition of items.</para>
1479 <para>Wrap each header file with the following syntax to prevent
1480 multiple inclusions of the file. Of course, replace PROJECT_H
1481 with your file name, with "." Changed to "_", and make it
1484 <para><emphasis>Example:</emphasis></para>
1486 #ifndef PROJECT_H_INCLUDED
1487 #define PROJECT_H_INCLUDED
1489 #endif /* ndef PROJECT_H_INCLUDED */
1494 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1496 <para><emphasis>Explanation:</emphasis></para>
1498 <para>If our headers are included from C++, they must declare our
1499 functions as `extern "C"`. This has no cost in C, but increases
1500 the potential re-usability of our code.</para>
1502 <para><emphasis>Example:</emphasis></para>
1507 #endif /* def __cplusplus */
1509 ... function definitions here ...
1513 #endif /* def __cplusplus */
1518 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1519 Declaration Instead of Includes</title>
1521 <para><emphasis>Explanation:</emphasis></para>
1523 <para>Useful in headers that include pointers to other struct's.
1524 Modifications to excess header files may cause needless
1527 <para><emphasis>Example:</emphasis></para>
1529 /*********************************************************************
1530 * We're avoiding an include statement here!
1531 *********************************************************************/
1533 extern file_list *xyz;</programlisting>
1535 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1536 pointer), then including the proper header file is necessary.
1537 If you only want to prototype a pointer, however, the header
1538 file is unnecessary.</para>
1540 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1546 <sect2 id="s35"><title>General Coding Practices</title>
1550 <sect3 id="s36"><title>Turn on warnings</title>
1552 <para><emphasis>Explanation</emphasis></para>
1554 <para>Compiler warnings are meant to help you find bugs. You
1555 should turn on as many as possible. With GCC, the switch is
1556 "-Wall". Try and fix as many warnings as possible.</para>
1562 <sect3 id="s37"><title>Provide a default case for all switch
1565 <para><emphasis>Explanation:</emphasis></para>
1567 <para>What you think is guaranteed is never really guaranteed. The
1568 value that you don't think you need to check is the one that
1569 someday will be passed. So, to protect yourself from the
1570 unknown, always have a default step in a switch statement.</para>
1572 <para><emphasis>Example:</emphasis></para>
1574 switch (hash_string(cmd))
1576 case hash_actions_file:
1586 ... anomaly code goes here ...
1587 continue; / break; / exit( 1 ); / etc ...
1589 } /* end switch (hash_string(cmd)) */</programlisting>
1591 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1592 are obviously exempt from this point. Of note, most of the
1593 WIN32 code calls `DefWindowProc' after the switch statement.
1594 This API call *should* be included in a default statement.</para>
1596 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1597 as a robust programming issue. The "anomaly code goes here" may
1598 be no more than a print to the STDERR stream (as in
1599 load_config). Or it may really be an abort condition.</para>
1601 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1607 <sect3 id="s38"><title>Try to avoid falling through cases in a
1608 switch statement.</title>
1610 <para><emphasis>Explanation:</emphasis></para>
1612 <para>In general, you will want to have a 'break' statement within
1613 each 'case' of a switch statement. This allows for the code to
1614 be more readable and understandable, and furthermore can
1615 prevent unwanted surprises if someone else later gets creative
1616 and moves the code around.</para>
1618 <para>The language allows you to plan the fall through from one
1619 case statement to another simply by omitting the break
1620 statement within the case statement. This feature does have
1621 benefits, but should only be used in rare cases. In general,
1622 use a break statement for each case statement.</para>
1624 <para>If you choose to allow fall through, you should comment both
1625 the fact of the fall through and reason why you felt it was
1632 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1634 <para><emphasis>Explanation:</emphasis></para>
1636 <para>The type of size_t varies across platforms. Do not make
1637 assumptions about whether it is signed or unsigned, or about
1638 how long it is. Do not compare a size_t against another
1639 variable of a different type (or even against a constant)
1640 without casting one of the values.</para>
1646 <sect3 id="s41"><title>Declare each variable and struct on its
1649 <para><emphasis>Explanation:</emphasis></para>
1651 <para>It can be tempting to declare a series of variables all on
1652 one line. Don't.</para>
1654 <para><emphasis>Example:</emphasis></para>
1658 long c = 0;</programlisting>
1660 <para><emphasis>Instead of:</emphasis></para>
1662 <para>long a, b, c;</para>
1664 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1665 individual variables - easier to add new variables without
1666 messing up the original ones - when searching on a variable to
1667 find its type, there is less clutter to "visually"
1670 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1671 variables or other trivial variables; feel free to declare them
1672 on one line. You should, although, provide a good comment on
1673 their functions.</para>
1675 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1681 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1683 <para><emphasis>Explanation:</emphasis></para>
1685 <para>Create a local struct (on the stack) if the variable will
1686 live and die within the context of one function call.</para>
1688 <para>Only "malloc" a struct (on the heap) if the variable's life
1689 will extend beyond the context of one function call.</para>
1691 <para><emphasis>Example:</emphasis></para>
1693 If a function creates a struct and stores a pointer to it in a
1694 list, then it should definitely be allocated via `malloc'.
1699 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1700 Responsible for Ensuring 'free'</title>
1702 <para><emphasis>Explanation:</emphasis></para>
1704 <para>If you have to "malloc" an instance, you are responsible for
1705 insuring that the instance is `free'd, even if the deallocation
1706 event falls within some other programmer's code. You are also
1707 responsible for ensuring that deletion is timely (i.e. not too
1708 soon, not too late). This is known as "low-coupling" and is a
1709 "good thing (tm)". You may need to offer a
1710 free/unload/destructor type function to accommodate this.</para>
1712 <para><emphasis>Example:</emphasis></para>
1714 int load_re_filterfile(struct client_state *csp) { ... }
1715 static void unload_re_filterfile(void *f) { ... }</programlisting>
1717 <para><emphasis>Exceptions:</emphasis></para>
1719 <para>The developer cannot be expected to provide `free'ing
1720 functions for C run-time library functions ... such as
1723 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1724 standard is for allocating and freeing data structures (complex
1731 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1732 and in order</title>
1734 <para><emphasis>Explanation:</emphasis></para>
1736 <para>I have ordered all of the "blocker" file code to be in alpha
1737 order. It is easier to add/read new blockers when you expect a
1738 certain order.</para>
1740 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1741 places by POPUP tests coming before PCRS tests. But since
1742 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1743 it should come first.</para>
1749 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1750 existing code, use XXX</title>
1752 <para><emphasis>Explanation:</emphasis></para>
1754 <para>If you have enough confidence in new code or confidence in
1755 your changes, but are not *quite* sure of the repercussions,
1758 <para>/* XXX: this code has a logic error on platform XYZ, *
1759 attempting to fix */ #ifdef PLATFORM ...changed code here...
1764 <para>/* XXX: I think the original author really meant this...
1765 */ ...changed code here...</para>
1769 <para>/* XXX: new code that *may* break something else... */
1770 ...new code here...</para>
1772 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1773 be a "good thing (tm)", it will be easier to identify and
1774 include in the project (or conversely exclude from the
1782 <sect2 id="s46"><title>Addendum: Template for files and function
1783 comment blocks:</title>
1785 <para><emphasis>Example for file comments:</emphasis></para>
1787 /*********************************************************************
1791 * Purpose : (Fill me in with a good description!)
1793 * Copyright : Written by and Copyright (C) 2001-2009
1794 * the Privoxy team. https://www.privoxy.org/
1796 * This program is free software; you can redistribute it
1797 * and/or modify it under the terms of the GNU General
1798 * Public License as published by the Free Software
1799 * Foundation; either version 2 of the License, or (at
1800 * your option) any later version.
1802 * This program is distributed in the hope that it will
1803 * be useful, but WITHOUT ANY WARRANTY; without even the
1804 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1805 * PARTICULAR PURPOSE. See the GNU General Public
1806 * License for more details.
1808 * The GNU General Public License should be included with
1809 * this file. If not, you can view it at
1810 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1811 * or write to the Free Software Foundation, Inc.,
1812 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1815 *********************************************************************/
1820 ...necessary include files for us to do our work...
1822 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1825 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1826 added to the "show-version" page. If this is a brand new
1827 creation by you, you are free to change the "Copyright" section
1828 to represent the rights you wish to maintain.</para>
1830 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1831 after the comment flower box is handy for (X|GNU)Emacs users to
1832 skip the verbiage and get to the heart of the code (via
1833 `forward-page' and `backward-page'). Please include it if you
1836 <para><emphasis>Example for file header comments:</emphasis></para>
1840 /*********************************************************************
1844 * Purpose : (Fill me in with a good description!)
1846 * Copyright : Written by and Copyright (C) 2001-2009
1847 * the Privoxy team. https://www.privoxy.org/
1849 * This program is free software; you can redistribute it
1850 * and/or modify it under the terms of the GNU General
1851 * Public License as published by the Free Software
1852 * Foundation; either version 2 of the License, or (at
1853 * your option) any later version.
1855 * This program is distributed in the hope that it will
1856 * be useful, but WITHOUT ANY WARRANTY; without even the
1857 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1858 * PARTICULAR PURPOSE. See the GNU General Public
1859 * License for more details.
1861 * The GNU General Public License should be included with
1862 * this file. If not, you can view it at
1863 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1864 * or write to the Free Software Foundation, Inc.,
1865 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1868 *********************************************************************/
1871 #include "project.h"
1877 ... function headers here ...
1880 /* Revision control strings from this header and associated .c file */
1881 extern const char FILENAME_rcs[];
1882 extern const char FILENAME_h_rcs[];
1889 #endif /* ndef _FILENAME_H */
1898 <para><emphasis>Example for function comments:</emphasis></para>
1900 /*********************************************************************
1902 * Function : FUNCTION_NAME
1904 * Description : (Fill me in with a good description!)
1907 * 1 : param1 = pointer to an important thing
1908 * 2 : x = pointer to something else
1910 * Returns : 0 => Ok, everything else is an error.
1912 *********************************************************************/
1913 int FUNCTION_NAME(void *param1, const char *x)
1921 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1922 able to parse our code to create a "self-documenting" web
1929 <!-- ~~~~~ New section ~~~~~ -->
1930 <sect1 id="testing"><title>Testing Guidelines</title>
1934 <!-- ~~~~~ New section ~~~~~ -->
1935 <sect2 id="testing-plan"><title>Testplan for releases</title>
1937 Explain release numbers. major, minor. developer releases. etc.
1939 <orderedlist numeration="arabic">
1941 Remove any existing rpm with rpm -e
1944 Remove any file that was left over. This includes (but is not limited to)
1947 <listitem><para>/var/log/privoxy</para></listitem>
1948 <listitem><para>/etc/privoxy</para></listitem>
1949 <listitem><para>/usr/sbin/privoxy</para></listitem>
1950 <listitem><para>/etc/init.d/privoxy</para></listitem>
1951 <listitem><para>/usr/doc/privoxy*</para></listitem>
1955 Install the rpm. Any error messages?
1957 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1958 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1959 autostart work?</para></listitem>
1960 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1961 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1964 <!-- XXX: Document how to write test reports and where to send them -->
1966 <!-- ~~~~~ New section ~~~~~ -->
1967 <sect2 id="fuzzing"><title>Fuzzing Privoxy</title>
1969 To make fuzzing more convenient, Privoxy can be configured
1970 with --enable-fuzz which will result in the --fuzz option
1974 Example (tested on ElectroBSD):
1977 # Compile Privoxy with instrumentation for afl
1978 $ export CC=afl-clang
1979 $ export CFLAGS="-fsanitize=address -ggdb"
1980 $ export CPPFLAGS=-I/usr/local/include/
1981 $ export LDFLAGS="-fsanitize=address -L/usr/local/lib"
1982 $ export AFL_USE_ASAN=1
1983 $ export AFL_HARDEN=1
1984 $ ./configure --with-debug --enable-extended-host-patterns --enable-accept-filter --enable-no-gifs --enable-compression --enable-strptime-sanity-checks --enable-external-filters --enable-fuzz
1987 Privoxy version 3.0.24 (http://www.privoxy.org/)
1988 Usage: ./privoxy [--config-test] [--chroot] [--help] [--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] [--version] [configfile]
1989 ./privoxy --fuzz fuzz-mode ./path/to/fuzzed/input [--stfu]
1991 Supported fuzz modes and the expected input:
1992 action: Text to parse as action file.
1993 client-request: Client request to parse. Currently incomplete
1994 client-header: Client header to parse.
1995 chunked-transfer-encoding: Chunk-encoded data to dechunk.
1996 deflate: deflate-compressed data to decompress.
1997 filter: Text to parse as filter file.
1998 gif: gif to deanimate.
1999 gzip: gzip-compressed data to decompress.
2000 pcrs-substitute: A pcrs-substitute to compile. Not a whole pcrs job! Example: Bla $1 bla C $3 blah.
2001 server-header: Server header to parse.
2002 server-response: Server response to parse.
2004 The following fuzz modes read data from stdin if the 'file' is '-'
2007 chunked-transfer-encoding
2017 $ export ASAN_OPTIONS='abort_on_error=1'
2018 $ mkdir input output
2019 $ echo '$1 bla fasel $2' > input/pcrs
2020 $ afl-fuzz -i input -o output -m none ~/git/privoxy/privoxy --fuzz pcrs-substitute - --stfu
2022 $ cat >input/pcrs.txt
2024 s@(.{1})[432](\d+)@$1$2$hostname@UgisT
2026 $ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla.filter --stfu
2031 <!-- ~~~~~ New section ~~~~~ -->
2032 <sect1 id="newrelease"><title>Releasing a New Version</title>
2034 When we release versions of <application>Privoxy</application>,
2035 our work leaves our cozy secret lab and has to work in the cold
2036 RealWorld[tm]. Once it is released, there is no way to call it
2037 back, so it is very important that great care is taken to ensure
2038 that everything runs fine, and not to introduce problems in the
2042 So when releasing a new version, please adhere exactly to the
2043 procedure outlined in this chapter.
2047 The following programs are required to follow this process:
2048 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
2049 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
2052 <sect2 id="versionnumbers">
2053 <title>Version numbers</title>
2056 First you need to determine which version number the release will have.
2057 <application>Privoxy</application> version numbers consist of three numbers,
2058 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2063 X, the version major, is rarely ever changed. It is increased by one if
2064 turning a development branch into stable substantially changes the functionality,
2065 user interface or configuration syntax. Majors 1 and 2 were
2066 <application>Junkbuster</application>, and 3 will be the first stable
2067 <application>Privoxy</application> release.
2072 Y, the version minor, represents the branch within the major version.
2073 At any point in time, there are two branches being maintained:
2074 The stable branch, with an even minor, say, 2N, in which no functionality is
2075 being added and only bug-fixes are made, and 2N+1, the development branch, in
2076 which the further development of <application>Privoxy</application> takes
2078 This enables us to turn the code upside down and inside out, while at the same time
2079 providing and maintaining a stable version.
2080 The minor is reset to zero (and one) when the major is incremented. When a development
2081 branch has matured to the point where it can be turned into stable, the old stable branch
2082 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2083 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2088 Z, the point or sub version, represents a release of the software within a branch.
2089 It is therefore incremented immediately before each code freeze.
2090 In development branches, only the even point versions correspond to actual releases,
2091 while the odd ones denote the evolving state of the sources on Git in between.
2092 It follows that Z is odd on Git in development branches most of the time. There, it gets
2093 increased to an even number immediately before a code freeze, and is increased to an odd
2094 number again immediately thereafter.
2095 This ensures that builds from Git snapshots are easily distinguished from released versions.
2096 The point version is reset to zero when the minor changes.
2099 Stable branches work a little differently, since there should be
2100 little to no development happening in such branches. Remember,
2101 only bugfixes, which presumably should have had some testing
2102 before being committed. Stable branches will then have their
2103 version reported as <literal>0.0.0</literal>, during that period
2104 between releases when changes are being added. This is to denote
2105 that this code is <emphasis>not for release</emphasis>. Then
2106 as the release nears, the version is bumped according: e.g.
2107 <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2112 In summary, the main Git trunk is the development branch where new
2113 features are being worked on for the next stable series. This should
2114 almost always be where the most activity takes place. There is always at
2115 least one stable branch from the trunk, e.g now it is
2116 <literal>3.0</literal>, which is only used to release stable versions.
2117 Once the initial *.0 release of the stable branch has been done, then as a
2118 rule, only bugfixes that have had prior testing should be committed to
2119 the stable branch. Once there are enough bugfixes to justify a new
2120 release, the version of this branch is again incremented Example: 3.0.0
2121 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2122 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2123 taking place. If any questions, please post to the devel list
2124 <emphasis>before</emphasis> committing to a stable branch!
2127 Developers should remember too that if they commit a bugfix to the stable
2128 branch, this will more than likely require a separate submission to the
2129 main trunk, since these are separate development trees within Git. If you
2130 are working on both, then this would require at least two separate check
2131 outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2132 which is <literal>v_3_0_branch</literal> at the moment).
2137 <sect2 id="beforerelease">
2138 <title>Before the Release: Freeze</title>
2140 The following <emphasis>must be done by one of the
2141 developers</emphasis> prior to each new release.
2146 Make sure that everybody who has worked on the code in the last
2147 couple of days has had a chance to yell <quote>no!</quote> in case
2148 they have pending changes/fixes in their pipelines. Announce the
2149 freeze so that nobody will interfere with last minute changes.
2154 Increment the version number (point from odd to even in development
2155 branches!) in <filename>configure.in</filename> and update the code
2156 status (CODE_STATUS="xxx") to one of "alpha", "beta" or "stable".
2157 Rebuild configure and GNUMakefile to make sure the updated values are
2163 Use the dok-release target to update the sgml documentation source files.
2168 If action file processing has changed and is not backward-compatible,
2169 make sure the "for-privoxy-version=x.y.z" minimum version number in
2170 default.action.master has been updated:
2174 #############################################################################
2175 #MASTER# COMMENT: The minimum Privoxy version:
2176 for-privoxy-version=3.0.11
2181 All documentation should be rebuild after the version bump.
2182 Finished docs should be then be committed to Git (for those
2183 without the ability to build these). Some docs may require
2184 rather obscure processing tools. <filename>config</filename>,
2185 the man page (and the html version of the man page)
2186 fall in this category. README, the man page, AUTHORS, and config
2187 should all also be committed to Git for other packagers. The
2188 formal docs should be uploaded to the webserver. See the
2189 Section "Updating the webserver" in this manual for details.
2194 The <citetitle>User Manual</citetitle> is also used for context
2195 sensitive help for the CGI editor. This is version sensitive, so that
2196 the user will get appropriate help for his/her release. So with
2197 each release a fresh version should be uploaded to the webserver
2198 (this is in addition to the main <citetitle>User Manual</citetitle>
2199 link from the main page since we need to keep manuals for various
2200 versions available). The CGI pages will link to something like
2201 <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
2202 will need to be updated for each new release. There is no Makefile
2203 target for this at this time!!! It needs to be done manually.
2208 All developers should look at the <filename>ChangeLog</filename> and
2209 make sure noteworthy changes are referenced.
2214 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2219 Tag all files in Git with the version number with
2220 <quote><command>cvs tag v_X_Y_Z</command></quote>.
2221 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2226 If the release was in a development branch, increase the point version
2227 from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2233 On the webserver, copy the user manual to a new top-level directory
2234 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2235 pages, which have the version as a prefix, will go into the right version of the manual.
2236 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2237 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2238 <filename>.</filename> (i.e. dot).
2244 <sect2 id="therelease">
2245 <title>Building and Releasing the Packages</title>
2247 Now the individual packages can be built and released. Note that for
2248 GPL reasons the first package to be released is always the source tarball.
2252 For <emphasis>all</emphasis> types of packages, including the source tarball,
2253 <emphasis>you must make sure that you build from clean sources by exporting
2254 the right version from Git into an empty directory</emphasis> (just press return when
2255 asked for a password):
2259 mkdir dist # delete or choose different name if it already exists
2261 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
2262 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2266 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2267 version information after export from Git. This is to make sure that
2268 all release packages, and with them, all future bug reports, are based
2269 on exactly the same code.
2274 Every significant release of Privoxy has included at least one
2275 package that either had incorrect versions of files, missing files,
2276 or incidental leftovers from a previous build process that gave
2277 unknown numbers of users headaches to try to figure out what was
2278 wrong. PLEASE, make sure you are using pristene sources, and are
2279 following the prescribed process!
2284 Please find additional instructions for the source tarball and the
2285 individual platform dependent binary packages below. And details
2286 on the Sourceforge release process below that.
2289 <sect3 id="pack-guidelines">
2290 <title>Note on Privoxy Packaging</title>
2292 Please keep these general guidelines in mind when putting together
2293 your package. These apply to <emphasis>all</emphasis> platforms!
2298 <application>Privoxy</application> <emphasis>requires</emphasis>
2299 write access to: all <filename>*.action</filename> files, all
2300 logfiles, and the <filename>trust</filename> file. You will
2301 need to determine the best way to do this for your platform.
2306 Please include up to date documentation. At a bare minimum:
2310 <filename>LICENSE</filename> (top-level directory)
2315 <filename>README</filename> (top-level directory)
2320 <filename>AUTHORS</filename> (top-level directory)
2325 <filename>man page</filename> (top-level directory, Unix-like
2331 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2336 <filename>FAQ</filename> (doc/webserver/faq/)
2340 Also suggested: <filename>Developer Manual</filename>
2341 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2342 (top-level directory). <filename>FAQ</filename> and the manuals are
2343 HTML docs. There are also text versions in
2344 <filename>doc/text/</filename> which could conceivably also be
2348 The documentation has been designed such that the manuals are linked
2349 to each other from parallel directories, and should be packaged
2350 that way. <filename>privoxy-index.html</filename> can also be
2351 included and can serve as a focal point for docs and other links of
2352 interest (and possibly renamed to <filename>index.html</filename>).
2353 This should be one level up from the manuals. There is a link also
2354 on this page to an HTMLized version of the man page. To avoid 404 for
2355 this, it is in Git as
2356 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2357 and should be included along with the manuals. There is also a
2358 css stylesheets that can be included for better presentation:
2359 <filename>p_doc.css</filename>. This should be in the same directory
2360 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2361 the manual directories).
2366 <filename>user.action</filename> and <filename>user.filter</filename>
2367 are designed for local preferences. Make sure these do not get overwritten!
2368 <filename>config</filename> should not be overwritten either. This
2369 has especially important configuration data in it.
2370 <filename>trust</filename> should be left in tact as well.
2375 Other configuration files (<filename>default.action</filename> and
2376 <filename>default.filter</filename>) should be installed as the new
2377 defaults, but all previously installed configuration files should be
2378 preserved as backups. This is just good manners :-) These files are
2379 likely to change between releases and contain important new features
2385 Please check platform specific notes in this doc, if you haven't
2386 done <quote>Privoxy</quote> packaging before for other platform
2387 specific issues. Conversely, please add any notes that you know
2388 are important for your platform (or contact one of the doc
2389 maintainers to do this if you can't).
2394 Packagers should do a <quote>clean</quote> install of their
2395 package after building it. So any previous installs should be
2396 removed first to ensure the integrity of the newly built package.
2397 Then run the package for a while to make sure there are no
2398 obvious problems, before uploading.
2406 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2408 First, <emphasis>make sure that you have freshly exported the right
2409 version into an empty directory</emphasis>. (See "Building and releasing
2410 packages" above). Then run:
2414 autoheader && autoconf && ./configure
2423 To upload the package to Sourceforge, simply issue
2429 Go to the displayed URL and release the file publicly on Sourceforge.
2430 For the change log field, use the relevant section of the
2431 <filename>ChangeLog</filename> file.
2435 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2437 In following text, replace <replaceable class="parameter">dist</replaceable>
2438 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2441 First, <emphasis>make sure that you have freshly exported the right
2442 version into an empty directory</emphasis>. (See "Building and releasing
2446 As the only exception to not changing anything after export from Git,
2447 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2448 and make sure that the version information and the RPM release number are
2449 correct. The RPM release numbers for each version start at one. Hence it must
2450 be reset to one if this is the first RPM for
2451 <replaceable class="parameter">dist</replaceable> which is built from version
2453 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">file
2454 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2455 release number for that version plus one.
2462 autoheader && autoconf && ./configure
2468 make <replaceable class="parameter">dist</replaceable>-dist
2471 To upload the package to Sourceforge, simply issue
2474 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2477 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2478 RPM release number as determined above.
2479 Go to the displayed URL and release the file publicly on Sourceforge.
2480 Use the release notes and change log from the source tarball package.
2484 <sect3 id="newrelease-os2"><title>OS/2</title>
2486 First, <emphasis>make sure that you have freshly exported the right
2487 version into an empty directory</emphasis>. (See "Building and releasing
2488 packages" above). Then get the OS/2 Setup module:
2491 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
2494 You will need a mix of development tools.
2495 The main compilation takes place with IBM Visual Age C++.
2496 Some ancillary work takes place with GNU tools, available from
2497 various sources like hobbes.nmsu.edu.
2498 Specificially, you will need <filename>autoheader</filename>,
2499 <filename>autoconf</filename> and <filename>sh</filename> tools.
2500 The packaging takes place with WarpIN, available from various sources, including
2501 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2504 Change directory to the <filename>os2setup</filename> directory.
2505 Edit the os2build.cmd file to set the final executable filename.
2509 installExeName='privoxyos2_setup_X.Y.Z.exe'
2512 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2513 in the <filename>PACKAGEID</filename> section:
2516 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2519 You're now ready to build. Run:
2525 You will find the WarpIN-installable executable in the
2526 <filename>./files</filename> directory. Upload this anonymously to
2527 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2528 for it, and you're done. Use the release notes and Change Log from the
2529 source tarball package.
2533 <sect3 id="newrelease-solaris"><title>Solaris</title>
2535 Login to Sourceforge's compilefarm via ssh:
2538 ssh cf.sourceforge.net
2541 Choose the right operating system (not the Debian one).
2542 When logged in, <emphasis>make sure that you have freshly exported the right
2543 version into an empty directory</emphasis>. (See "Building and releasing
2544 packages" above). Then run:
2548 autoheader && autoconf && ./configure
2557 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2558 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2559 to manually upload the archive to Sourceforge's ftp server and release
2560 the file publicly. Use the release notes and Change Log from the
2561 source tarball package.
2565 <sect3 id="newrelease-windows"><title>Windows</title>
2567 Use the <ulink url="http://www.fruitbat.org/Cygwin/index.html#cygwincirca">
2568 Cygwin Time Machine</ulink> to install the last 1.5 version of Cygwin.
2569 Run the following commands from within the Cygwin 1.5 bash shell.
2572 First, <emphasis>make sure that you have freshly exported the right
2573 version into an empty directory</emphasis>. (See "Building and releasing
2574 packages" above). Then get the Windows setup module:
2577 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
2580 Then you can build the package. This is fully automated, and is
2581 controlled by <filename>winsetup/GNUmakefile</filename>.
2582 All you need to do is:
2589 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2590 <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2591 SourceForge. When releasing the package on SourceForge, use the release notes
2592 and Change Log from the source tarball package.
2596 <sect3 id="newrelease-debian"><title>Debian</title>
2598 First, <emphasis>make sure that you have freshly exported the
2599 right version into an empty directory</emphasis>. (See
2600 "Building and releasing packages" above). Then add a log
2601 entry to <filename>debian/changelog</filename>, if it is not
2602 already there, for example by running:
2605 debchange -v &p-version;-&p-status;-1 "New upstream version"
2611 dpkg-buildpackage -rfakeroot -us -uc -b
2615 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2616 which can be uploaded. To upload the package to Sourceforge, simply
2624 <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2626 First, <emphasis>make sure that you have freshly exported the right
2627 version into an empty directory</emphasis>. (See "Building and releasing
2631 There are three modules available in the Git repository for use on Mac
2632 OS X, though technically only two of them generate a release (the other
2633 can be used to install from source).
2635 <sect4 id="OS-X-OSXPackageBuilder-module">
2636 <title>OSXPackageBuilder module</title>
2638 The OSXPackageBuilder module generates OS X installer packages
2639 supporting all Macs running OS X 10.4 and above. Obtain it from Git as
2640 follows into a folder parallel to the exported privoxy source:
2643 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
2646 The module contains complete instructions on its usage in the file
2647 <filename>OS X Package Builder HOWTO.txt</filename>.
2650 Once the package(s) have been generated, you can then upload them
2651 directly to the Files section of the Sourceforge project in the
2652 Macintosh (OS X) folder. Each new version release of Privoxy should
2653 have a new subfolder created in which to store its files. Please
2654 ensure that the folder contains a readme file that makes it clear
2655 which package is for whichversion of OS X.
2658 <sect4 id="OS-X-osxsetup-module">
2659 <title>osxsetup module (DEPRECATED)</title>
2661 <emphasis>This module is deprecated since the installer it generates
2662 places all Privoxy files in one folder in a non-standard location, and
2663 supports only Intel Macs running OS X 10.6 or higher.</emphasis>
2666 Check out the module from Git as follows into a folder parallel to the
2667 exported privoxy source:
2670 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2680 This will run <filename>autoheader</filename>, <filename>autoconf</filename>
2681 and <filename>configure</filename> as well as <filename>make</filename>.
2682 Finally, it will copy over the necessary files to the ./osxsetup/files
2683 directory for further processing by <filename>PackageMaker</filename>.
2686 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
2687 modify the package name to match the release, and hit the "Create
2688 package" button. If you specify ./Privoxy.pkg as the output package
2689 name, you can then create the distributable zip file with the command:
2692 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2695 You can then upload this file directly to the Files section of the
2696 Sourceforge project in the Macintosh (OS X) folder. Each new version
2697 release of Privoxy should have a new subfolder created in which to
2699 Please ensure that the folder contains a readme file that makes it
2700 clear which version(s) of OS X the package supports.
2703 <sect4 id="OS-X-macsetup-module">
2704 <title>macsetup module</title>
2706 The macsetup module is ideal if you wish to build and install Privoxy
2707 from source on a single machine.
2710 Check out the module from Git as follows into a folder parallel to the
2711 exported privoxy source:
2714 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
2717 The module contains complete instructions on its usage in its
2718 <filename>README</filename> file. The end result will be the
2719 exported version of Privoxy installed on the build machine.
2724 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2726 Update the www/privoxy port and submit a diff upstream.
2727 For details see the <ulink url="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/">FreeBSD Porter's Handbook</ulink>.
2732 <sect2 id="releasing">
2733 <title>Uploading and Releasing Your Package</title>
2735 After the package is ready, it is time to upload it
2736 to SourceForge, and go through the release steps. The upload
2742 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2747 user: <literal>anonymous</literal>
2752 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2757 Or use the <command>make</command> targets as described above.
2760 Once this done go to <ulink
2761 url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
2762 >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2763 making sure you are logged in. Find your target platform in the
2764 second column, and click <literal>Add Release</literal>. You will
2765 then need to create a new release for your package, using the format
2766 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2770 Now just follow the prompts. Be sure to add any appropriate Release
2771 notes. You should see your freshly uploaded packages in
2772 <quote>Step 2. Add Files To This Release</quote>. Check the
2773 appropriate box(es). Remember at each step to hit the
2774 <quote>Refresh/Submit</quote> buttons! You should now see your
2775 file(s) listed in Step 3. Fill out the forms with the appropriate
2776 information for your platform, being sure to hit <quote>Update</quote>
2777 for each file. If anyone is monitoring your platform, check the
2778 <quote>email</quote> box at the very bottom to notify them of
2779 the new package. This should do it!
2782 If you have made errors, or need to make changes, you can go through
2783 essentially the same steps, but select <literal>Edit Release</literal>,
2784 instead of <literal>Add Release</literal>.
2788 <sect2 id="afterrelease">
2789 <title>After the Release</title>
2791 When all (or: most of the) packages have been uploaded and made available,
2792 send an email to the <ulink url="mailto:privoxy-announce@lists.privoxy.org">announce
2793 mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2795 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">download
2796 location</ulink>, the release notes and the Changelog. Also, post an
2797 updated News item on the project page Sourceforge, and update the Home
2798 page and docs linked from the Home page (see below). Other news sites
2799 and release oriented sites, such as Freshmeat, should also be notified.
2805 <!-- ~~~~~ New section ~~~~~ -->
2806 <sect1 id="webserver-update"><title>Update the Webserver</title>
2808 The webserver should be updated at least with each stable release. When
2809 updating, please follow these steps to make sure that no broken links,
2810 inconsistent contents or permission problems will occur (as it has many
2811 times in the past!):
2814 If you have changed anything in the stable-branch documentation source
2821 That will generate <filename>doc/webserver/user-manual</filename>,
2822 <filename>doc/webserver/developer-manual</filename>,
2823 <filename>doc/webserver/faq</filename>,
2824 <filename>doc/webserver/index.html</filename> automatically.
2827 If you changed the manual page sources, generate
2828 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2829 by running <quote><command>make man</command></quote>. (This is
2830 a separate target due to dependencies on some obscure perl scripts
2831 [now in Git, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2834 If you want to add new files to the webserver, create them locally in
2835 the <filename>doc/webserver/*</filename> directory (or
2836 create new directories under <filename>doc/webserver</filename>).
2839 Next, commit any changes from the above steps to Git. All set?
2840 If these are docs in the stable branch, then do:
2846 This will do the upload to <ulink url="https://www.privoxy.org/">the
2847 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2848 there are group writable.
2851 Please do <emphasis>NOT</emphasis> use any other means of transferring
2852 files to the webserver to avoid permission problems. Also, please do not
2853 upload docs from development branches or versions. The publicly posted
2854 docs should be in sync with the last official release.
2860 This program is free software; you can redistribute it
2861 and/or modify it under the terms of the GNU General
2862 Public License as published by the Free Software
2863 Foundation; either version 2 of the License, or (at
2864 your option) any later version.
2866 This program is distributed in the hope that it will
2867 be useful, but WITHOUT ANY WARRANTY; without even the
2868 implied warranty of MERCHANTABILITY or FITNESS FOR A
2869 PARTICULAR PURPOSE. See the GNU General Public
2870 License for more details.
2872 The GNU General Public License should be included with
2873 this file. If not, you can view it at
2874 http://www.gnu.org/copyleft/gpl.html
2875 or write to the Free Software Foundation, Inc., 59
2876 Temple Place - Suite 330, Boston, MA 02111-1307, USA.