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.25">
9 <!entity p-status "beta">
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 : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
20 Purpose : developer manual
21 This file belongs into
22 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
24 $Id: developer-manual.sgml,v 2.71 2016/05/27 15:24:13 fabiankeil Exp $
26 Copyright (C) 2001-2016 Privoxy Developers https://www.privoxy.org/
29 ========================================================================
30 NOTE: Please read developer-manual/documentation.html before touching
31 anything in this, or other Privoxy documentation. You have been warned!
32 Failure to abide by this rule will result in the revocation of your license
33 to live a peaceful existence!
34 ========================================================================
40 <title>Privoxy Developer Manual</title>
43 <!-- Completely the wrong markup, but very little is allowed -->
44 <!-- in this part of an article. FIXME -->
45 <ulink url="https://www.privoxy.org/user-manual/copyright.html">Copyright</ulink>
46 &my-copy; 2001-2016 by
47 <ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
52 <pubdate>$Id: developer-manual.sgml,v 2.71 2016/05/27 15:24:13 fabiankeil Exp $</pubdate>
56 Note: this should generate a separate page, and a live link to it.
57 But it doesn't for some mysterious reason. Please leave commented
58 unless it can be fixed proper. For the time being, the copyright
59 statement will be in copyright.smgl.
63 <legalnotice id="legalnotice">
65 text goes here ........
76 This is here to keep vim syntax file from breaking :/
77 If I knew enough to fix it, I would.
78 PLEASE DO NOT REMOVE! HB: hal@foobox.net
83 The developer manual provides guidance on coding, testing, packaging, documentation
84 and other issues of importance to those involved with
85 <application>Privoxy</application> development. It is mandatory (and helpful!) reading
86 for anyone who wants to join the team. Note that it's currently out of date
87 and may not be entirely correct. As always, patches are welcome.
90 <!-- Include privoxy.sgml boilerplate text: -->
92 <!-- &p-intro; Someone interested enough in the project to contribute
93 will already know at this point what Privoxy is. -->
95 <!-- end boilerplate -->
98 Please note that this document is constantly evolving. This copy represents
99 the state at the release of version &p-version;.
100 You can find the latest version of the this manual at <ulink
101 url="https://www.privoxy.org/developer-manual/">https://www.privoxy.org/developer-manual/</ulink>.
102 Please have a look at the
103 <ulink url="https://www.privoxy.org/user-manual/contact.html">contact section in the user manual</ulink>
104 if you are interested in contacting the developers.
111 <!-- ~~~~~ New section ~~~~~ -->
112 <sect1 id="introduction"><title>Introduction</title>
115 I don't like seeing blank space :) So added *something* here.
119 <application>Privoxy</application>, as an heir to
120 <application>Junkbuster</application>, is a Free Software project
121 and the code is licensed under the GNU General Public License version 2.
122 As such, <application>Privoxy</application> development is potentially open
123 to anyone who has the time, knowledge, and desire to contribute
124 in any capacity. Our goals are simply to continue the mission,
125 to improve <application>Privoxy</application>, and
126 to make it available to as wide an audience as possible.
129 One does not have to be a programmer to contribute. Packaging, testing,
130 documenting and porting, are all important jobs as well.
133 <!-- ~~~~~ New section ~~~~~ -->
134 <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
136 The first step is to join the <ulink
137 url="https://lists.privoxy.org/mailman/listinfo/privoxy-devel">privoxy-devel mailing list</ulink>.
138 You can submit your ideas, or even better patches. Patches are best
139 submitted to the Sourceforge tracker set up for this purpose, but
140 can be sent to the list for review too.
143 You will also need to have a cvs package installed, which will
144 entail having ssh installed as well (which seems to be a requirement of
145 SourceForge), in order to access the cvs repository. Having the GNU build
146 tools is also going to be important (particularly, autoconf and gmake).
149 For the time being (read, this section is under construction), you can
150 also refer to the extensive comments in the source code. In fact,
151 reading the code is recommended in any case.
156 <!-- ~~~~~ New section ~~~~~ -->
157 <sect1 id="cvs"><title>The CVS Repository</title>
159 If you become part of the active development team, you will eventually
160 need write access to our holy grail, the CVS repository. One of the
161 team members will need to set this up for you. Please read
162 this chapter completely before accessing via CVS.
165 <sect2 id="cvsaccess"><title>Access to CVS</title>
167 The project's CVS repository is hosted on
168 <ulink url="https://sourceforge.net/">SourceForge.</ulink>
169 For historical reasons, the CVS server is
170 called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
171 called <literal>ijbswa</literal>, and the source tree module is called
172 <literal>current</literal>.
176 <sect2 id="cvsbranches">
177 <title>Branches</title>
179 Within the CVS repository, there are modules and branches. As
180 mentioned, the sources are in the <literal>current</literal>
181 <quote>module</quote>. Other modules are present for platform specific
182 issues. There is a webview of the CVS hierarchy at <ulink
183 url="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/"
184 >http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</ulink>,
185 which might help with visualizing how these pieces fit together.
189 Branches are used to fork a sub-development path from the main trunk.
190 Within the <literal>current</literal> module where the sources are, there
191 is always at least one <quote>branch</quote> from the main trunk
192 devoted to a stable release series. The main trunk is where active
193 development takes place for the next stable series (e.g. 3.2.x).
194 So just prior to each stable series (e.g. 3.0.x), a branch is created
195 just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
196 Once the initial stable release of any stable branch has taken place,
197 this branch is <emphasis>only used for bugfixes</emphasis>, which have
198 had prior testing before being committed to CVS. (See <link
199 linkend="versionnumbers">Version Numbers</link> below for details on
204 At one time there were two distinct branches: stable and unstable. The
205 more drastic changes were to be in the unstable branch. These branches
206 have now been merged to minimize time and effort of maintaining two
211 This will result in at least two active branches, which means there may
212 be occasions that require the same (or similar) item to be
213 checked into to two different places (assuming its a bugfix and needs
214 fixing in both the stable and unstable trees). This also means that in
215 order to have access to both trees, both will have to be checked out
216 separately. Use the <literal>cvs -r</literal> flag to check out a
217 branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
222 <sect2 id="cvscommit"><title>CVS Commit Guidelines</title>
224 The source tree is the heart of every software project. Every effort must
225 be made to ensure that it is readable, compilable and consistent at all
226 times. <!-- There are differing guidelines for the stable branch and the
227 main development trunk, and --> We expect anyone with CVS access to strictly
228 adhere to the following guidelines:
232 Basic Guidelines, for all branches:
237 Please don't commit even
238 a small change without testing it thoroughly first. When we're
239 close to a public release, ask a fellow developer to review your
243 Your commit message should give a concise overview of <emphasis>what you
244 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
245 Just check previous messages for good examples.
248 Don't use the same message on multiple files, unless it equally applies to
252 If your changes span multiple files, and the code won't recompile unless
253 all changes are committed (e.g. when changing the signature of a function),
254 then commit all files one after another, without long delays in between.
255 If necessary, prepare the commit messages in advance.
258 Before changing things on CVS, make sure that your changes are in line
259 with the team's general consensus on what should be done.
263 Note that near a major public release, we get more cautious.
264 There is always the possibility to submit a patch to the <ulink
265 url="https://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
266 tracker</ulink> instead.
274 Stable branches are handled with more care, especially after the
275 initial *.*.0 release, and we are just in bugfix mode. In addition to
276 the above, the below applies only to the stable branch (currently the
277 <literal>v_3_0_branch</literal> branch):
284 Do not commit <emphasis>anything</emphasis> unless your proposed
285 changes have been well tested first, preferably by other members of the
286 project, or have prior approval of the project leaders or consensus
292 Where possible, bugfixes and changes should be tested in the main
293 development trunk first. There may be occasions where this is not
299 Alternately, proposed changes can be submitted as patches to the patch tracker on
300 Sourceforge first: <ulink
301 url="https://sourceforge.net/tracker/?group_id=11118&atid=311118">https://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
302 Then ask for peer review.
307 Do not even think about anything except bugfixes. No new features!
318 <!-- ~~~~~ New section ~~~~~ -->
319 <sect1 id="documentation"><title>Documentation Guidelines</title>
321 All formal documents are maintained in Docbook SGML and located in the
322 <computeroutput>doc/source/*</computeroutput> directory. You will need
323 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
324 DTD's and the Docbook modular stylesheets (or comparable alternatives),
325 and either <application>jade</application> or
326 <application>openjade</application> (recommended) installed in order to
327 build docs from source. Currently there is <ulink
328 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
329 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
330 course this, the <citetitle>developer-manual</citetitle> in this format.
331 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
332 <citetitle>INSTALL</citetitle>,
333 <citetitle>privoxy.1</citetitle> (man page), and
334 <citetitle>config</citetitle> files are also now maintained as Docbook
335 SGML. These files, when built, in the top-level source directory are
336 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
337 variation on this file, <filename>privoxy-index.html</filename>,
338 meant for inclusion with doc packages), are maintained as SGML as well.
339 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
340 contact someone involved in the documentation.
343 <filename>config</filename> requires some special handling. The reason it
344 is maintained this way is so that the extensive comments in the file
345 mirror those in <citetitle>user-manual</citetitle>. But the conversion
346 process requires going from SGML to HTML to text to special formatting
347 required for the embedded comments. Some of this does not survive so
348 well. Especially some of the examples that are longer than 80 characters.
349 The build process for this file outputs to <filename>config.new</filename>,
350 which should be reviewed for errors and mis-formatting. Once satisfied
351 that it is correct, then it should be hand copied to
352 <filename>config</filename>.
355 Other, less formal documents (e.g. <filename>LICENSE</filename>) are
356 maintained as plain text files in the top-level source directory.
359 Packagers are encouraged to include this documentation. For those without
360 the ability to build the docs locally, text versions of each are kept in
361 CVS. HTML versions are also being kept in CVS under
362 <filename>doc/webserver/*</filename>.
365 Formal documents are built with the Makefile targets of
366 <computeroutput>make dok</computeroutput>.
367 The build process uses the document SGML sources in
368 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
369 <computeroutput>doc/text/</computeroutput> and to update all HTML
370 documents in <computeroutput>doc/webserver/</computeroutput>.
373 Documentation writers should please make sure documents build
374 successfully before committing to CVS, if possible.
377 How do you update the webserver (i.e. the pages on privoxy.org)?
379 <orderedlist numeration="arabic">
381 First, build the docs by running <computeroutput>make
382 dok</computeroutput>.
385 Run <computeroutput>make webserver</computeroutput> which copies all
386 files from <computeroutput>doc/webserver</computeroutput> to the
387 sourceforge webserver via scp.
393 Finished docs should be occasionally submitted to CVS
394 (<filename>doc/webserver/*/*.html</filename>) so that those without
395 the ability to build them locally, have access to them if needed.
396 This is especially important just prior to a new release! Please
397 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
398 other release specific data in <filename>configure.in</filename> has been
399 updated (this is done just prior to a new release).
402 <!-- ~~~~~ New section ~~~~~ -->
404 <title>Quickstart to Docbook and SGML</title>
406 If you are not familiar with SGML, it is a markup language similar to HTML.
407 Actually, not a mark up language per se, but a language used to define
408 markup languages. In fact, HTML is an SGML application. Both will use
409 <quote>tags</quote> to format text and other content. SGML tags can be much
410 more varied, and flexible, but do much of the same kinds of things. The tags,
411 or <quote>elements</quote>, are definable in SGML. There is no set
412 <quote>standards</quote>. Since we are using
413 <application>Docbook</application>, our tags are those that are defined by
414 <application>Docbook</application>. Much of how the finish document is
415 rendered is determined by the <quote>stylesheets</quote>.
416 The stylesheets determine how each tag gets translated to HTML, or other
421 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
422 will likely generate errors. Example: <literal><title>My
423 Title</title></literal>. They are also case-insensitive, but we
424 strongly suggest using all lower case. This keeps compatibility with
425 [Docbook] <application>XML</application>.
429 Our documents use <quote>sections</quote> for the most part. Sections
430 will be processed into HTML headers (e.g. <literal>h1</literal> for
431 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
432 will use these to also generate the Table of Contents for each doc. Our
433 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
434 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
435 entries, but <literal>sect4</literal> will not. Each section requires
436 a <literal><title></literal> element, and at least one
437 <literal><para></literal>. There is a limit of five section
438 levels in Docbook, but generally three should be sufficient for our
443 Some common elements that you likely will use:
449 <emphasis><para></para></emphasis>, paragraph delimiter. Most
450 text needs to be within paragraph elements (there are some exceptions).
453 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
457 <emphasis><filename></filename></emphasis>, files and directories.
460 <emphasis><command></command></emphasis>, command examples.
463 <emphasis><literallayout></literallayout></emphasis>, like
464 <literal><pre></literal>, more or less.
467 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
470 <emphasis><listitem></listitem></emphasis>, member of the above.
473 <emphasis><screen></screen></emphasis>, screen output, implies
474 <literal><literallayout></literal>.
477 <emphasis><ulink url="example.com"></ulink></emphasis>, like
478 HTML <literal><a></literal> tag.
481 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
487 Look at any of the existing docs for examples of all these and more.
491 You might also find <quote><ulink
492 url="http://opensource.bureau-cornavin.com/crash-course/index.html">Writing Documentation
493 Using DocBook - A Crash Course</ulink></quote> useful.
497 <!-- ~~~~~ New section ~~~~~ -->
498 <sect2 id="docstyle">
499 <title><application>Privoxy</application> Documentation Style</title>
501 It will be easier if everyone follows a similar writing style. This
502 just makes it easier to read what someone else has written if it
503 is all done in a similar fashion.
512 All tags should be lower case.
517 Tags delimiting a <emphasis>block</emphasis> of text (even small
518 blocks) should be on their own line. Like:
524 Tags marking individual words, or few words, should be in-line:
526 Just to <emphasis>emphasize</emphasis>, some text goes here.
532 Tags should be nested and step indented for block text like: (except
539 Some text goes here in our list example.
542 </itemizedlist>
545 This makes it easier to find the text amongst the tags ;-)
550 Use white space to separate logical divisions within a document,
551 like between sections. Running everything together consistently
552 makes it harder to read and work on.
557 Do not hesitate to make comments. Comments can either use the
558 <comment> element, or the <!-- --> style comment
559 familiar from HTML. (Note in Docbook v4.x <comment> is
560 replaced by <remark>.)
565 We have an international audience. Refrain from slang, or English
566 idiosyncrasies (too many to list :). Humor also does not translate
572 Try to keep overall line lengths in source files to 80 characters or less
573 for obvious reasons. This is not always possible, with lengthy URLs for
579 Our documents are available in differing formats. Right now, they
580 are just plain text and/or HTML, but others are always a
581 future possibility. Be careful with URLs (<ulink>), and avoid
585 My favorite site is <ulink url="http://example.com">here</ulink>.
588 This will render as <quote>My favorite site is here</quote>, which is
589 not real helpful in a text doc. Better like this:
592 My favorite site is <ulink url="http://example.com">example.com</ulink>.
597 All documents should be spell checked occasionally.
598 <application>aspell</application> can check SGML with the
599 <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.
641 Re- <quote>boilerplate</quote> text entities are defined like:
644 <literal><!entity supported SYSTEM "supported.sgml"></literal>
647 In this example, the contents of the file,
648 <filename>supported.sgml</filename> is available for inclusion anywhere
649 in the doc. To make this happen, just reference the now defined
650 entity: <literal>&supported;</literal> (starts with an ampersand
651 and ends with a semi-colon), and the contents will be dumped into
652 the finished doc at that point.
657 Commonly used <quote>internal entities</quote>:
661 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
662 version string, e.g. <quote>&p-version;</quote>.
665 <emphasis>p-status</emphasis>: the project status, either
666 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
669 <emphasis>p-not-stable</emphasis>: use to conditionally include
670 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
673 <emphasis>p-stable</emphasis>: just the opposite.
676 <emphasis>p-text</emphasis>: this doc is only generated as text.
683 There are others in various places that are defined for a specific
684 purpose. Read the source!
691 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
692 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
694 <!-- ~~~~~ New section ~~~~~ -->
695 <sect1 id="coding"><title>Coding Guidelines</title>
697 <sect2 id="s1"><title>Introduction</title>
699 <para>This set of standards is designed to make our lives easier. It is
700 developed with the simple goal of helping us keep the "new and improved
701 <application>Privoxy</application>" consistent and reliable. Thus making
702 maintenance easier and increasing chances of success of the
705 <para>And that of course comes back to us as individuals. If we can
706 increase our development and product efficiencies then we can solve more
707 of the request for changes/improvements and in general feel good about
708 ourselves. ;-></para>
712 <sect2 id="s2"><title>Using Comments</title>
715 <sect3 id="s3"><title>Comment, Comment, Comment</title>
717 <para><emphasis>Explanation:</emphasis></para>
719 <para>Comment as much as possible without commenting the obvious.
720 For example do not comment "variable_a is equal to variable_b".
721 Instead explain why variable_a should be equal to the variable_b.
722 Just because a person can read code does not mean they will
723 understand why or what is being done. A reader may spend a lot
724 more time figuring out what is going on when a simple comment
725 or explanation would have prevented the extra research. Please
726 help your fellow Privoxy developers out!</para>
728 <para>The comments will also help justify the intent of the code.
729 If the comment describes something different than what the code
730 is doing then maybe a programming error is occurring.</para>
732 <para><emphasis>Example:</emphasis></para>
734 /* if page size greater than 1k ... */
735 if (page_length() > 1024)
737 ... "block" the page up ...
740 /* if page size is small, send it in blocks */
741 if (page_length() > 1024)
743 ... "block" the page up ...
746 This demonstrates 2 cases of "what not to do". The first is a
747 "syntax comment". The second is a comment that does not fit what
748 is actually being done.
754 <sect3 id="s4"><title>Use blocks for comments</title>
756 <para><emphasis>Explanation:</emphasis></para>
758 <para>Comments can help or they can clutter. They help when they
759 are differentiated from the code they describe. One line
760 comments do not offer effective separation between the comment
761 and the code. Block identifiers do, by surrounding the code
762 with a clear, definable pattern.</para>
764 <para><emphasis>Example:</emphasis></para>
766 /*********************************************************************
767 * This will stand out clearly in your code!
768 *********************************************************************/
769 if (this_variable == that_variable)
771 do_something_very_important();
775 /* unfortunately, this may not */
776 if (this_variable == that_variable)
778 do_something_very_important();
782 if (this_variable == that_variable) /* this may not either */
784 do_something_very_important();
787 <para><emphasis>Exception:</emphasis></para>
789 <para>If you are trying to add a small logic comment and do not
790 wish to "disrupt" the flow of the code, feel free to use a 1
791 line comment which is NOT on the same line as the code.</para>
797 <sect3 id="s5"><title>Keep Comments on their own line</title>
799 <para><emphasis>Explanation:</emphasis></para>
801 <para>It goes back to the question of readability. If the comment
802 is on the same line as the code it will be harder to read than
803 the comment that is on its own line.</para>
805 <para>There are three exceptions to this rule, which should be
806 violated freely and often: during the definition of variables,
807 at the end of closing braces, when used to comment
810 <para><emphasis>Example:</emphasis></para>
812 /*********************************************************************
813 * This will stand out clearly in your code,
814 * But the second example won't.
815 *********************************************************************/
816 if (this_variable == this_variable)
818 do_something_very_important();
821 if (this_variable == this_variable) /*can you see me?*/
823 do_something_very_important(); /*not easily*/
827 /*********************************************************************
828 * But, the encouraged exceptions:
829 *********************************************************************/
830 int urls_read = 0; /* # of urls read + rejected */
831 int urls_rejected = 0; /* # of urls rejected */
835 do_something_very_important();
839 short do_something_very_important(
840 short firstparam, /* represents something */
841 short nextparam /* represents something else */ )
845 } /* -END- do_something_very_important */
850 <sect3 id="s6"><title>Comment each logical step</title>
852 <para><emphasis>Explanation:</emphasis></para>
854 <para>Logical steps should be commented to help others follow the
855 intent of the written code and comments will make the code more
858 <para>If you have 25 lines of code without a comment, you should
859 probably go back into it to see where you forgot to put
862 <para>Most "for", "while", "do", etc... loops _probably_ need a
863 comment. After all, these are usually major logic
870 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
872 <para><emphasis>Explanation:</emphasis></para>
874 <para>A reader of the code should be able to look at the comments
875 just prior to the beginning of a function and discern the
876 reason for its existence and the consequences of using it. The
877 reader should not have to read through the code to determine if
878 a given function is safe for a desired use. The proper
879 information thoroughly presented at the introduction of a
880 function not only saves time for subsequent maintenance or
881 debugging, it more importantly aids in code reuse by allowing a
882 user to determine the safety and applicability of any function
883 for the problem at hand. As a result of such benefits, all
884 functions should contain the information presented in the
885 addendum section of this document.</para>
891 <sect3 id="s8"><title>Comment at the end of braces if the
892 content is more than one screen length</title>
894 <para><emphasis>Explanation:</emphasis></para>
896 <para>Each closing brace should be followed on the same line by a
897 comment that describes the origination of the brace if the
898 original brace is off of the screen, or otherwise far away from
899 the closing brace. This will simplify the debugging,
900 maintenance, and readability of the code.</para>
902 <para>As a suggestion , use the following flags to make the
903 comment and its brace more readable:</para>
905 <para>use following a closing brace: } /* -END- if() or while ()
908 <para><emphasis>Example:</emphasis></para>
912 do_something_very_important();
913 ...some long list of commands...
914 } /* -END- if x is 1 */
920 do_something_very_important();
921 ...some long list of commands...
922 } /* -END- if (1 == X) */
928 <sect2 id="s9"><title>Naming Conventions</title>
932 <sect3 id="s10"><title>Variable Names</title>
934 <para><emphasis>Explanation:</emphasis></para>
936 <para>Use all lowercase, and separate words via an underscore
937 ('_'). Do not start an identifier with an underscore. (ANSI C
938 reserves these for use by the compiler and system headers.) Do
939 not use identifiers which are reserved in ANSI C++. (E.g.
940 template, class, true, false, ...). This is in case we ever
941 decide to port Privoxy to C++.</para>
943 <para><emphasis>Example:</emphasis></para>
945 int ms_iis5_hack = 0;</programlisting>
947 <para><emphasis>Instead of:</emphasis></para>
951 int msiis5hack = 0; int msIis5Hack = 0;
959 <sect3 id="s11"><title>Function Names</title>
961 <para><emphasis>Explanation:</emphasis></para>
963 <para>Use all lowercase, and separate words via an underscore
964 ('_'). Do not start an identifier with an underscore. (ANSI C
965 reserves these for use by the compiler and system headers.) Do
966 not use identifiers which are reserved in ANSI C++. (E.g.
967 template, class, true, false, ...). This is in case we ever
968 decide to port Privoxy to C++.</para>
970 <para><emphasis>Example:</emphasis></para>
972 int load_some_file(struct client_state *csp)</programlisting>
974 <para><emphasis>Instead of:</emphasis></para>
978 int loadsomefile(struct client_state *csp)
979 int loadSomeFile(struct client_state *csp)
987 <sect3 id="s12"><title>Header file prototypes</title>
989 <para><emphasis>Explanation:</emphasis></para>
991 <para>Use a descriptive parameter name in the function prototype
992 in header files. Use the same parameter name in the header file
993 that you use in the c file.</para>
995 <para><emphasis>Example:</emphasis></para>
997 (.h) extern int load_aclfile(struct client_state *csp);
998 (.c) int load_aclfile(struct client_state *csp)</programlisting>
1000 <para><emphasis>Instead of:</emphasis>
1002 (.h) extern int load_aclfile(struct client_state *); or
1003 (.h) extern int load_aclfile();
1004 (.c) int load_aclfile(struct client_state *csp)
1012 <sect3 id="s13"><title>Enumerations, and #defines</title>
1014 <para><emphasis>Explanation:</emphasis></para>
1016 <para>Use all capital letters, with underscores between words. Do
1017 not start an identifier with an underscore. (ANSI C reserves
1018 these for use by the compiler and system headers.)</para>
1020 <para><emphasis>Example:</emphasis></para>
1022 (enumeration) : enum Boolean {FALSE, TRUE};
1023 (#define) : #define DEFAULT_SIZE 100;</programlisting>
1025 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
1026 that toggle a feature in the preprocessor: FEATURE_>, where
1027 > is a short (preferably 1 or 2 word) description.</para>
1029 <para><emphasis>Example:</emphasis></para>
1031 #define FEATURE_FORCE 1
1033 #ifdef FEATURE_FORCE
1034 #define FORCE_PREFIX blah
1035 #endif /* def FEATURE_FORCE */
1040 <sect3 id="s14"><title>Constants</title>
1042 <para><emphasis>Explanation:</emphasis></para>
1044 <para>Spell common words out entirely (do not remove vowels).</para>
1046 <para>Use only widely-known domain acronyms and abbreviations.
1047 Capitalize all letters of an acronym.</para>
1049 <para>Use underscore (_) to separate adjacent acronyms and
1050 abbreviations. Never terminate a name with an underscore.</para>
1052 <para><emphasis>Example:</emphasis></para>
1054 #define USE_IMAGE_LIST 1</programlisting>
1056 <para><emphasis>Instead of:</emphasis></para>
1060 #define USE_IMG_LST 1 or
1061 #define _USE_IMAGE_LIST 1 or
1062 #define USE_IMAGE_LIST_ 1 or
1063 #define use_image_list 1 or
1064 #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>
1469 /* This is not a local include, but requires a path element. */
1470 #include <sys/fileName.h>
1474 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1475 without a _very_ good reason. This duplicates the #include
1476 "file.h" behavior.</para>
1482 <sect3 id="s32"><title>Provide multiple inclusion
1485 <para><emphasis>Explanation:</emphasis></para>
1487 <para>Prevents compiler and linker errors resulting from
1488 redefinition of items.</para>
1490 <para>Wrap each header file with the following syntax to prevent
1491 multiple inclusions of the file. Of course, replace PROJECT_H
1492 with your file name, with "." Changed to "_", and make it
1495 <para><emphasis>Example:</emphasis></para>
1497 #ifndef PROJECT_H_INCLUDED
1498 #define PROJECT_H_INCLUDED
1500 #endif /* ndef PROJECT_H_INCLUDED */
1505 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1507 <para><emphasis>Explanation:</emphasis></para>
1509 <para>If our headers are included from C++, they must declare our
1510 functions as `extern "C"`. This has no cost in C, but increases
1511 the potential re-usability of our code.</para>
1513 <para><emphasis>Example:</emphasis></para>
1518 #endif /* def __cplusplus */
1520 ... function definitions here ...
1524 #endif /* def __cplusplus */
1529 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1530 Declaration Instead of Includes</title>
1532 <para><emphasis>Explanation:</emphasis></para>
1534 <para>Useful in headers that include pointers to other struct's.
1535 Modifications to excess header files may cause needless
1538 <para><emphasis>Example:</emphasis></para>
1540 /*********************************************************************
1541 * We're avoiding an include statement here!
1542 *********************************************************************/
1544 extern file_list *xyz;</programlisting>
1546 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1547 pointer), then including the proper header file is necessary.
1548 If you only want to prototype a pointer, however, the header
1549 file is unnecessary.</para>
1551 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1557 <sect2 id="s35"><title>General Coding Practices</title>
1561 <sect3 id="s36"><title>Turn on warnings</title>
1563 <para><emphasis>Explanation</emphasis></para>
1565 <para>Compiler warnings are meant to help you find bugs. You
1566 should turn on as many as possible. With GCC, the switch is
1567 "-Wall". Try and fix as many warnings as possible.</para>
1573 <sect3 id="s37"><title>Provide a default case for all switch
1576 <para><emphasis>Explanation:</emphasis></para>
1578 <para>What you think is guaranteed is never really guaranteed. The
1579 value that you don't think you need to check is the one that
1580 someday will be passed. So, to protect yourself from the
1581 unknown, always have a default step in a switch statement.</para>
1583 <para><emphasis>Example:</emphasis></para>
1585 switch (hash_string(cmd))
1587 case hash_actions_file:
1597 ... anomaly code goes here ...
1598 continue; / break; / exit( 1 ); / etc ...
1600 } /* end switch (hash_string(cmd)) */</programlisting>
1602 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1603 are obviously exempt from this point. Of note, most of the
1604 WIN32 code calls `DefWindowProc' after the switch statement.
1605 This API call *should* be included in a default statement.</para>
1607 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1608 as a robust programming issue. The "anomaly code goes here" may
1609 be no more than a print to the STDERR stream (as in
1610 load_config). Or it may really be an abort condition.</para>
1612 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1618 <sect3 id="s38"><title>Try to avoid falling through cases in a
1619 switch statement.</title>
1621 <para><emphasis>Explanation:</emphasis></para>
1623 <para>In general, you will want to have a 'break' statement within
1624 each 'case' of a switch statement. This allows for the code to
1625 be more readable and understandable, and furthermore can
1626 prevent unwanted surprises if someone else later gets creative
1627 and moves the code around.</para>
1629 <para>The language allows you to plan the fall through from one
1630 case statement to another simply by omitting the break
1631 statement within the case statement. This feature does have
1632 benefits, but should only be used in rare cases. In general,
1633 use a break statement for each case statement.</para>
1635 <para>If you choose to allow fall through, you should comment both
1636 the fact of the fall through and reason why you felt it was
1643 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1645 <para><emphasis>Explanation:</emphasis></para>
1647 <para>The type of size_t varies across platforms. Do not make
1648 assumptions about whether it is signed or unsigned, or about
1649 how long it is. Do not compare a size_t against another
1650 variable of a different type (or even against a constant)
1651 without casting one of the values.</para>
1657 <sect3 id="s41"><title>Declare each variable and struct on its
1660 <para><emphasis>Explanation:</emphasis></para>
1662 <para>It can be tempting to declare a series of variables all on
1663 one line. Don't.</para>
1665 <para><emphasis>Example:</emphasis></para>
1669 long c = 0;</programlisting>
1671 <para><emphasis>Instead of:</emphasis></para>
1673 <para>long a, b, c;</para>
1675 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1676 individual variables - easier to add new variables without
1677 messing up the original ones - when searching on a variable to
1678 find its type, there is less clutter to "visually"
1681 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1682 variables or other trivial variables; feel free to declare them
1683 on one line. You should, although, provide a good comment on
1684 their functions.</para>
1686 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1692 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1694 <para><emphasis>Explanation:</emphasis></para>
1696 <para>Create a local struct (on the stack) if the variable will
1697 live and die within the context of one function call.</para>
1699 <para>Only "malloc" a struct (on the heap) if the variable's life
1700 will extend beyond the context of one function call.</para>
1702 <para><emphasis>Example:</emphasis></para>
1704 If a function creates a struct and stores a pointer to it in a
1705 list, then it should definitely be allocated via `malloc'.
1710 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1711 Responsible for Ensuring 'free'</title>
1713 <para><emphasis>Explanation:</emphasis></para>
1715 <para>If you have to "malloc" an instance, you are responsible for
1716 insuring that the instance is `free'd, even if the deallocation
1717 event falls within some other programmer's code. You are also
1718 responsible for ensuring that deletion is timely (i.e. not too
1719 soon, not too late). This is known as "low-coupling" and is a
1720 "good thing (tm)". You may need to offer a
1721 free/unload/destructor type function to accommodate this.</para>
1723 <para><emphasis>Example:</emphasis></para>
1725 int load_re_filterfile(struct client_state *csp) { ... }
1726 static void unload_re_filterfile(void *f) { ... }</programlisting>
1728 <para><emphasis>Exceptions:</emphasis></para>
1730 <para>The developer cannot be expected to provide `free'ing
1731 functions for C run-time library functions ... such as
1734 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1735 standard is for allocating and freeing data structures (complex
1742 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1743 and in order</title>
1745 <para><emphasis>Explanation:</emphasis></para>
1747 <para>I have ordered all of the "blocker" file code to be in alpha
1748 order. It is easier to add/read new blockers when you expect a
1749 certain order.</para>
1751 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1752 places by POPUP tests coming before PCRS tests. But since
1753 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1754 it should come first.</para>
1760 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1761 existing code, use XXX</title>
1763 <para><emphasis>Explanation:</emphasis></para>
1765 <para>If you have enough confidence in new code or confidence in
1766 your changes, but are not *quite* sure of the repercussions,
1769 <para>/* XXX: this code has a logic error on platform XYZ, *
1770 attempting to fix */ #ifdef PLATFORM ...changed code here...
1775 <para>/* XXX: I think the original author really meant this...
1776 */ ...changed code here...</para>
1780 <para>/* XXX: new code that *may* break something else... */
1781 ...new code here...</para>
1783 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1784 be a "good thing (tm)", it will be easier to identify and
1785 include in the project (or conversely exclude from the
1793 <sect2 id="s46"><title>Addendum: Template for files and function
1794 comment blocks:</title>
1796 <para><emphasis>Example for file comments:</emphasis></para>
1798 const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
1799 /*********************************************************************
1801 * File : $S<!-- Break CVS Substitution -->ource$
1803 * Purpose : (Fill me in with a good description!)
1805 * Copyright : Written by and Copyright (C) 2001-2009
1806 * the Privoxy team. https://www.privoxy.org/
1808 * This program is free software; you can redistribute it
1809 * and/or modify it under the terms of the GNU General
1810 * Public License as published by the Free Software
1811 * Foundation; either version 2 of the License, or (at
1812 * your option) any later version.
1814 * This program is distributed in the hope that it will
1815 * be useful, but WITHOUT ANY WARRANTY; without even the
1816 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1817 * PARTICULAR PURPOSE. See the GNU General Public
1818 * License for more details.
1820 * The GNU General Public License should be included with
1821 * this file. If not, you can view it at
1822 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1823 * or write to the Free Software Foundation, Inc.,
1824 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1827 *********************************************************************/
1832 ...necessary include files for us to do our work...
1834 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1837 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1838 added to the "show-proxy-args" page. If this is a brand new
1839 creation by you, you are free to change the "Copyright" section
1840 to represent the rights you wish to maintain.</para>
1842 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1843 after the comment flower box is handy for (X|GNU)Emacs users to
1844 skip the verbiage and get to the heart of the code (via
1845 `forward-page' and `backward-page'). Please include it if you
1848 <para><emphasis>Example for file header comments:</emphasis></para>
1852 #define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
1853 /*********************************************************************
1855 * File : $S<!-- Break CVS Substitution -->ource$
1857 * Purpose : (Fill me in with a good description!)
1859 * Copyright : Written by and Copyright (C) 2001-2009
1860 * the Privoxy team. https://www.privoxy.org/
1862 * This program is free software; you can redistribute it
1863 * and/or modify it under the terms of the GNU General
1864 * Public License as published by the Free Software
1865 * Foundation; either version 2 of the License, or (at
1866 * your option) any later version.
1868 * This program is distributed in the hope that it will
1869 * be useful, but WITHOUT ANY WARRANTY; without even the
1870 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1871 * PARTICULAR PURPOSE. See the GNU General Public
1872 * License for more details.
1874 * The GNU General Public License should be included with
1875 * this file. If not, you can view it at
1876 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
1877 * or write to the Free Software Foundation, Inc.,
1878 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ,
1881 *********************************************************************/
1884 #include "project.h"
1890 ... function headers here ...
1893 /* Revision control strings from this header and associated .c file */
1894 extern const char FILENAME_rcs[];
1895 extern const char FILENAME_h_rcs[];
1902 #endif /* ndef _FILENAME_H */
1911 <para><emphasis>Example for function comments:</emphasis></para>
1913 /*********************************************************************
1915 * Function : FUNCTION_NAME
1917 * Description : (Fill me in with a good description!)
1920 * 1 : param1 = pointer to an important thing
1921 * 2 : x = pointer to something else
1923 * Returns : 0 => Ok, everything else is an error.
1925 *********************************************************************/
1926 int FUNCTION_NAME(void *param1, const char *x)
1934 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1935 able to parse our code to create a "self-documenting" web
1942 <!-- ~~~~~ New section ~~~~~ -->
1943 <sect1 id="testing"><title>Testing Guidelines</title>
1947 <!-- ~~~~~ New section ~~~~~ -->
1948 <sect2 id="testing-plan"><title>Testplan for releases</title>
1950 Explain release numbers. major, minor. developer releases. etc.
1952 <orderedlist numeration="arabic">
1954 Remove any existing rpm with rpm -e
1957 Remove any file that was left over. This includes (but is not limited to)
1959 <listitem><para>/var/log/privoxy</para></listitem>
1960 <listitem><para>/etc/privoxy</para></listitem>
1961 <listitem><para>/usr/sbin/privoxy</para></listitem>
1962 <listitem><para>/etc/init.d/privoxy</para></listitem>
1963 <listitem><para>/usr/doc/privoxy*</para></listitem>
1967 Install the rpm. Any error messages?
1969 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1970 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1971 autostart work?</para></listitem>
1972 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1973 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1977 <!-- XXX: Document how to write test reports and where to send them -->
1980 <!-- ~~~~~ New section ~~~~~ -->
1981 <sect1 id="newrelease"><title>Releasing a New Version</title>
1983 When we release versions of <application>Privoxy</application>,
1984 our work leaves our cozy secret lab and has to work in the cold
1985 RealWorld[tm]. Once it is released, there is no way to call it
1986 back, so it is very important that great care is taken to ensure
1987 that everything runs fine, and not to introduce problems in the
1991 So when releasing a new version, please adhere exactly to the
1992 procedure outlined in this chapter.
1996 The following programs are required to follow this process:
1997 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
1998 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
2001 <sect2 id="versionnumbers">
2002 <title>Version numbers</title>
2005 First you need to determine which version number the release will have.
2006 <application>Privoxy</application> version numbers consist of three numbers,
2007 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
2011 X, the version major, is rarely ever changed. It is increased by one if
2012 turning a development branch into stable substantially changes the functionality,
2013 user interface or configuration syntax. Majors 1 and 2 were
2014 <application>Junkbuster</application>, and 3 will be the first stable
2015 <application>Privoxy</application> release.
2020 Y, the version minor, represents the branch within the major version.
2021 At any point in time, there are two branches being maintained:
2022 The stable branch, with an even minor, say, 2N, in which no functionality is
2023 being added and only bug-fixes are made, and 2N+1, the development branch, in
2024 which the further development of <application>Privoxy</application> takes
2026 This enables us to turn the code upside down and inside out, while at the same time
2027 providing and maintaining a stable version.
2028 The minor is reset to zero (and one) when the major is incremented. When a development
2029 branch has matured to the point where it can be turned into stable, the old stable branch
2030 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2031 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2036 Z, the point or sub version, represents a release of the software within a branch.
2037 It is therefore incremented immediately before each code freeze.
2038 In development branches, only the even point versions correspond to actual releases,
2039 while the odd ones denote the evolving state of the sources on CVS in between.
2040 It follows that Z is odd on CVS in development branches most of the time. There, it gets
2041 increased to an even number immediately before a code freeze, and is increased to an odd
2042 number again immediately thereafter.
2043 This ensures that builds from CVS snapshots are easily distinguished from released versions.
2044 The point version is reset to zero when the minor changes.
2047 Stable branches work a little differently, since there should be
2048 little to no development happening in such branches. Remember,
2049 only bugfixes, which presumably should have had some testing
2050 before being committed. Stable branches will then have their
2051 version reported as <literal>0.0.0</literal>, during that period
2052 between releases when changes are being added. This is to denote
2053 that this code is <emphasis>not for release</emphasis>. Then
2054 as the release nears, the version is bumped according: e.g.
2055 <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
2061 In summary, the main CVS trunk is the development branch where new
2062 features are being worked on for the next stable series. This should
2063 almost always be where the most activity takes place. There is always at
2064 least one stable branch from the trunk, e.g now it is
2065 <literal>3.0</literal>, which is only used to release stable versions.
2066 Once the initial *.0 release of the stable branch has been done, then as a
2067 rule, only bugfixes that have had prior testing should be committed to
2068 the stable branch. Once there are enough bugfixes to justify a new
2069 release, the version of this branch is again incremented Example: 3.0.0
2070 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
2071 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
2072 taking place. If any questions, please post to the devel list
2073 <emphasis>before</emphasis> committing to a stable branch!
2076 Developers should remember too that if they commit a bugfix to the stable
2077 branch, this will more than likely require a separate submission to the
2078 main trunk, since these are separate development trees within CVS. If you
2079 are working on both, then this would require at least two separate check
2080 outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
2081 which is <literal>v_3_0_branch</literal> at the moment).
2086 <sect2 id="beforerelease">
2087 <title>Before the Release: Freeze</title>
2089 The following <emphasis>must be done by one of the
2090 developers</emphasis> prior to each new release.
2096 Make sure that everybody who has worked on the code in the last
2097 couple of days has had a chance to yell <quote>no!</quote> in case
2098 they have pending changes/fixes in their pipelines. Announce the
2099 freeze so that nobody will interfere with last minute changes.
2104 Increment the version number (point from odd to even in development
2105 branches!) in <filename>configure.in</filename>. (RPM spec files
2106 will need to be incremented as well.)
2111 If <filename>default.action</filename> has changed since last
2112 release (i.e. software release or standalone actions file release),
2113 bump up its version info to A.B in this line:
2117 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
2121 Then change the version info in doc/webserver/actions/index.php,
2122 line: '$required_actions_file_version = "A.B";'
2127 All documentation should be rebuild after the version bump.
2128 Finished docs should be then be committed to CVS (for those
2129 without the ability to build these). Some docs may require
2130 rather obscure processing tools. <filename>config</filename>,
2131 the man page (and the html version of the man page)
2132 fall in this category. REAMDE, the man page, AUTHORS, and config
2133 should all also be committed to CVS for other packagers. The
2134 formal docs should be uploaded to the webserver. See the
2135 Section "Updating the webserver" in this manual for details.
2140 The <citetitle>User Manual</citetitle> is also used for context
2141 sensitive help for the CGI editor. This is version sensitive, so that
2142 the user will get appropriate help for his/her release. So with
2143 each release a fresh version should be uploaded to the webserver
2144 (this is in addition to the main <citetitle>User Manual</citetitle>
2145 link from the main page since we need to keep manuals for various
2146 versions available). The CGI pages will link to something like
2147 <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
2148 will need to be updated for each new release. There is no Makefile
2149 target for this at this time!!! It needs to be done manually.
2154 All developers should look at the <filename>ChangeLog</filename> and
2155 make sure noteworthy changes are referenced.
2160 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2165 Tag all files in CVS with the version number with
2166 <quote><command>cvs tag v_X_Y_Z</command></quote>.
2167 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2172 If the release was in a development branch, increase the point version
2173 from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2179 On the webserver, copy the user manual to a new top-level directory
2180 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2181 pages, which have the version as a prefix, will go into the right version of the manual.
2182 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2183 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2184 <filename>.</filename> (i.e. dot).
2191 <sect2 id="therelease">
2192 <title>Building and Releasing the Packages</title>
2194 Now the individual packages can be built and released. Note that for
2195 GPL reasons the first package to be released is always the source tarball.
2199 For <emphasis>all</emphasis> types of packages, including the source tarball,
2200 <emphasis>you must make sure that you build from clean sources by exporting
2201 the right version from CVS into an empty directory</emphasis> (just press return when
2202 asked for a password):
2207 mkdir dist # delete or choose different name if it already exists
2209 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
2210 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2215 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2216 version information after export from CVS. This is to make sure that
2217 all release packages, and with them, all future bug reports, are based
2218 on exactly the same code.
2223 Every significant release of Privoxy has included at least one
2224 package that either had incorrect versions of files, missing files,
2225 or incidental leftovers from a previous build process that gave
2226 unknown numbers of users headaches to try to figure out what was
2227 wrong. PLEASE, make sure you are using pristene sources, and are
2228 following the prescribed process!
2233 Please find additional instructions for the source tarball and the
2234 individual platform dependent binary packages below. And details
2235 on the Sourceforge release process below that.
2238 <sect3 id="pack-guidelines">
2239 <title>Note on Privoxy Packaging</title>
2241 Please keep these general guidelines in mind when putting together
2242 your package. These apply to <emphasis>all</emphasis> platforms!
2248 <application>Privoxy</application> <emphasis>requires</emphasis>
2249 write access to: all <filename>*.action</filename> files, all
2250 logfiles, and the <filename>trust</filename> file. You will
2251 need to determine the best way to do this for your platform.
2256 Please include up to date documentation. At a bare minimum:
2260 <filename>LICENSE</filename> (top-level directory)
2265 <filename>README</filename> (top-level directory)
2270 <filename>AUTHORS</filename> (top-level directory)
2275 <filename>man page</filename> (top-level directory, Unix-like
2281 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2286 <filename>FAQ</filename> (doc/webserver/faq/)
2290 Also suggested: <filename>Developer Manual</filename>
2291 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2292 (top-level directory). <filename>FAQ</filename> and the manuals are
2293 HTML docs. There are also text versions in
2294 <filename>doc/text/</filename> which could conceivably also be
2298 The documentation has been designed such that the manuals are linked
2299 to each other from parallel directories, and should be packaged
2300 that way. <filename>privoxy-index.html</filename> can also be
2301 included and can serve as a focal point for docs and other links of
2302 interest (and possibly renamed to <filename>index.html</filename>).
2303 This should be one level up from the manuals. There is a link also
2304 on this page to an HTMLized version of the man page. To avoid 404 for
2305 this, it is in CVS as
2306 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2307 and should be included along with the manuals. There is also a
2308 css stylesheets that can be included for better presentation:
2309 <filename>p_doc.css</filename>. This should be in the same directory
2310 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2311 the manual directories).
2316 <filename>user.action</filename> and <filename>user.filter</filename>
2317 are designed for local preferences. Make sure these do not get overwritten!
2318 <filename>config</filename> should not be overwritten either. This
2319 has especially important configuration data in it.
2320 <filename>trust</filename> should be left in tact as well.
2325 Other configuration files (<filename>default.action</filename> and
2326 <filename>default.filter</filename>) should be installed as the new
2327 defaults, but all previously installed configuration files should be
2328 preserved as backups. This is just good manners :-) These files are
2329 likely to change between releases and contain important new features
2335 Please check platform specific notes in this doc, if you haven't
2336 done <quote>Privoxy</quote> packaging before for other platform
2337 specific issues. Conversely, please add any notes that you know
2338 are important for your platform (or contact one of the doc
2339 maintainers to do this if you can't).
2344 Packagers should do a <quote>clean</quote> install of their
2345 package after building it. So any previous installs should be
2346 removed first to ensure the integrity of the newly built package.
2347 Then run the package for a while to make sure there are no
2348 obvious problems, before uploading.
2357 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2359 First, <emphasis>make sure that you have freshly exported the right
2360 version into an empty directory</emphasis>. (See "Building and releasing
2361 packages" above). Then run:
2366 autoheader && autoconf && ./configure
2378 To upload the package to Sourceforge, simply issue
2386 Go to the displayed URL and release the file publicly on Sourceforge.
2387 For the change log field, use the relevant section of the
2388 <filename>ChangeLog</filename> file.
2392 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2394 In following text, replace <replaceable class="parameter">dist</replaceable>
2395 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2398 First, <emphasis>make sure that you have freshly exported the right
2399 version into an empty directory</emphasis>. (See "Building and releasing
2403 As the only exception to not changing anything after export from CVS,
2404 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2405 and make sure that the version information and the RPM release number are
2406 correct. The RPM release numbers for each version start at one. Hence it must
2407 be reset to one if this is the first RPM for
2408 <replaceable class="parameter">dist</replaceable> which is built from version
2410 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">file
2411 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2412 release number for that version plus one.
2420 autoheader && autoconf && ./configure
2428 make <replaceable class="parameter">dist</replaceable>-dist
2432 To upload the package to Sourceforge, simply issue
2436 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2440 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2441 RPM release number as determined above.
2442 Go to the displayed URL and release the file publicly on Sourceforge.
2443 Use the release notes and change log from the source tarball package.
2447 <sect3 id="newrelease-os2"><title>OS/2</title>
2449 First, <emphasis>make sure that you have freshly exported the right
2450 version into an empty directory</emphasis>. (See "Building and releasing
2451 packages" above). Then get the OS/2 Setup module:
2455 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
2459 You will need a mix of development tools.
2460 The main compilation takes place with IBM Visual Age C++.
2461 Some ancillary work takes place with GNU tools, available from
2462 various sources like hobbes.nmsu.edu.
2463 Specificially, you will need <filename>autoheader</filename>,
2464 <filename>autoconf</filename> and <filename>sh</filename> tools.
2465 The packaging takes place with WarpIN, available from various sources, including
2466 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2469 Change directory to the <filename>os2setup</filename> directory.
2470 Edit the os2build.cmd file to set the final executable filename.
2475 installExeName='privoxyos2_setup_X.Y.Z.exe'
2479 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2480 in the <filename>PACKAGEID</filename> section:
2484 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2488 You're now ready to build. Run:
2496 You will find the WarpIN-installable executable in the
2497 <filename>./files</filename> directory. Upload this anonymously to
2498 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2499 for it, and you're done. Use the release notes and Change Log from the
2500 source tarball package.
2504 <sect3 id="newrelease-solaris"><title>Solaris</title>
2506 Login to Sourceforge's compilefarm via ssh:
2510 ssh cf.sourceforge.net
2514 Choose the right operating system (not the Debian one).
2515 When logged in, <emphasis>make sure that you have freshly exported the right
2516 version into an empty directory</emphasis>. (See "Building and releasing
2517 packages" above). Then run:
2522 autoheader && autoconf && ./configure
2534 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2535 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2536 to manually upload the archive to Sourceforge's ftp server and release
2537 the file publicly. Use the release notes and Change Log from the
2538 source tarball package.
2542 <sect3 id="newrelease-windows"><title>Windows</title>
2544 Use the <ulink url="http://www.fruitbat.org/Cygwin/index.html#cygwincirca">
2545 Cygwin Time Machine</ulink> to install the last 1.5 version of Cygwin.
2546 Run the following commands from within the Cygwin 1.5 bash shell.
2549 First, <emphasis>make sure that you have freshly exported the right
2550 version into an empty directory</emphasis>. (See "Building and releasing
2551 packages" above). Then get the Windows setup module:
2555 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
2559 Then you can build the package. This is fully automated, and is
2560 controlled by <filename>winsetup/GNUmakefile</filename>.
2561 All you need to do is:
2570 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2571 <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2572 SourceForge. When releasing the package on SourceForge, use the release notes
2573 and Change Log from the source tarball package.
2577 <sect3 id="newrelease-debian"><title>Debian</title>
2579 First, <emphasis>make sure that you have freshly exported the
2580 right version into an empty directory</emphasis>. (See
2581 "Building and releasing packages" above). Then add a log
2582 entry to <filename>debian/changelog</filename>, if it is not
2583 already there, for example by running:
2587 debchange -v &p-version;-&p-status;-1 "New upstream version"
2595 dpkg-buildpackage -rfakeroot -us -uc -b
2600 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2601 which can be uploaded. To upload the package to Sourceforge, simply
2611 <sect3 id="newrelease-macosx"><title>Mac OS X</title>
2613 First, <emphasis>make sure that you have freshly exported the right
2614 version into an empty directory</emphasis>. (See "Building and releasing
2618 There are three modules available in the CVS repository for use on Mac
2619 OS X, though technically only two of them generate a release (the other
2620 can be used to install from source).
2622 <sect4 id="OS-X-OSXPackageBuilder-module">
2623 <title>OSXPackageBuilder module</title>
2625 The OSXPackageBuilder module generates OS X installer packages
2626 supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
2627 follows into a folder parallel to the exported privoxy source:
2629 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
2633 The module contains complete instructions on its usage in the file
2634 <filename>OS X Package Builder HOWTO.txt</filename>.
2637 Once the package(s) have been generated, you can then upload them
2638 directly to the Files section of the Sourceforge project in the
2639 Macintosh (OS X) folder. Each new version release of Privoxy should
2640 have a new subfolder created in which to store its files. Please
2641 ensure that the folder contains a readme file that makes it clear
2642 which package is for whichversion of OS X.
2645 <sect4 id="OS-X-osxsetup-module">
2646 <title>osxsetup module (DEPRECATED)</title>
2648 <emphasis>This module is deprecated since the installer it generates
2649 places all Privoxy files in one folder in a non-standard location, and
2650 supports only Intel Macs running OS X 10.6 or higher.</emphasis>
2653 Check out the module from CVS as follows into a folder parallel to the
2654 exported privoxy source:
2656 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
2669 This will run <filename>autoheader</filename>, <filename>autoconf</filename>
2670 and <filename>configure</filename> as well as <filename>make</filename>.
2671 Finally, it will copy over the necessary files to the ./osxsetup/files
2672 directory for further processing by <filename>PackageMaker</filename>.
2675 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
2676 modify the package name to match the release, and hit the "Create
2677 package" button. If you specify ./Privoxy.pkg as the output package
2678 name, you can then create the distributable zip file with the command:
2682 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2686 You can then upload this file directly to the Files section of the
2687 Sourceforge project in the Macintosh (OS X) folder. Each new version
2688 release of Privoxy should have a new subfolder created in which to
2690 Please ensure that the folder contains a readme file that makes it
2691 clear which version(s) of OS X the package supports.
2694 <sect4 id="OS-X-macsetup-module">
2695 <title>macsetup module</title>
2697 The macsetup module is ideal if you wish to build and install Privoxy
2698 from source on a single machine.
2701 Check out the module from CVS as follows into a folder parallel to the
2702 exported privoxy source:
2704 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
2708 The module contains complete instructions on its usage in its
2709 <filename>README</filename> file. The end result will be the
2710 exported version of Privoxy installed on the build machine.
2715 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2717 Update the www/privoxy port and submit a diff upstream.
2718 For details see the <ulink url="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/">FreeBSD Porter's Handbook</ulink>.
2723 <sect2 id="releasing">
2724 <title>Uploading and Releasing Your Package</title>
2726 After the package is ready, it is time to upload it
2727 to SourceForge, and go through the release steps. The upload
2734 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2739 user: <literal>anonymous</literal>
2744 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2750 Or use the <command>make</command> targets as described above.
2753 Once this done go to <ulink
2754 url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
2755 >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2756 making sure you are logged in. Find your target platform in the
2757 second column, and click <literal>Add Release</literal>. You will
2758 then need to create a new release for your package, using the format
2759 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2763 Now just follow the prompts. Be sure to add any appropriate Release
2764 notes. You should see your freshly uploaded packages in
2765 <quote>Step 2. Add Files To This Release</quote>. Check the
2766 appropriate box(es). Remember at each step to hit the
2767 <quote>Refresh/Submit</quote> buttons! You should now see your
2768 file(s) listed in Step 3. Fill out the forms with the appropriate
2769 information for your platform, being sure to hit <quote>Update</quote>
2770 for each file. If anyone is monitoring your platform, check the
2771 <quote>email</quote> box at the very bottom to notify them of
2772 the new package. This should do it!
2775 If you have made errors, or need to make changes, you can go through
2776 essentially the same steps, but select <literal>Edit Release</literal>,
2777 instead of <literal>Add Release</literal>.
2781 <sect2 id="afterrelease">
2782 <title>After the Release</title>
2784 When all (or: most of the) packages have been uploaded and made available,
2785 send an email to the <ulink url="mailto:privoxy-announce@lists.privoxy.org">announce
2786 mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2788 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">download
2789 location</ulink>, the release notes and the Changelog. Also, post an
2790 updated News item on the project page Sourceforge, and update the Home
2791 page and docs linked from the Home page (see below). Other news sites
2792 and release oriented sites, such as Freshmeat, should also be notified.
2798 <!-- ~~~~~ New section ~~~~~ -->
2799 <sect1 id="webserver-update"><title>Update the Webserver</title>
2801 The webserver should be updated at least with each stable release. When
2802 updating, please follow these steps to make sure that no broken links,
2803 inconsistent contents or permission problems will occur (as it has many
2804 times in the past!):
2807 If you have changed anything in the stable-branch documentation source
2816 That will generate <filename>doc/webserver/user-manual</filename>,
2817 <filename>doc/webserver/developer-manual</filename>,
2818 <filename>doc/webserver/faq</filename>,
2819 <filename>doc/webserver/index.html</filename> automatically.
2822 If you changed the manual page sources, generate
2823 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2824 by running <quote><command>make man</command></quote>. (This is
2825 a separate target due to dependencies on some obscure perl scripts
2826 [now in CVS, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
2829 If you want to add new files to the webserver, create them locally in
2830 the <filename>doc/webserver/*</filename> directory (or
2831 create new directories under <filename>doc/webserver</filename>).
2834 Next, commit any changes from the above steps to CVS. All set?
2835 If these are docs in the stable branch, then do:
2843 This will do the upload to <ulink url="https://www.privoxy.org/">the
2844 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2845 there are group writable.
2848 Please do <emphasis>NOT</emphasis> use any other means of transferring
2849 files to the webserver to avoid permission problems. Also, please do not
2850 upload docs from development branches or versions. The publicly posted
2851 docs should be in sync with the last official release.
2857 This program is free software; you can redistribute it
2858 and/or modify it under the terms of the GNU General
2859 Public License as published by the Free Software
2860 Foundation; either version 2 of the License, or (at
2861 your option) any later version.
2863 This program is distributed in the hope that it will
2864 be useful, but WITHOUT ANY WARRANTY; without even the
2865 implied warranty of MERCHANTABILITY or FITNESS FOR A
2866 PARTICULAR PURPOSE. See the GNU General Public
2867 License for more details.
2869 The GNU General Public License should be included with
2870 this file. If not, you can view it at
2871 http://www.gnu.org/copyleft/gpl.html
2872 or write to the Free Software Foundation, Inc., 59
2873 Temple Place - Suite 330, Boston, MA 02111-1307, USA.