1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
2 <!entity % dummy "INCLUDE">
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 contacting SYSTEM "contacting.sgml">
9 <!entity copyright SYSTEM "copyright.sgml">
10 <!entity p-version "2.9.14">
11 <!entity p-status "beta">
12 <!entity % p-not-stable "INCLUDE">
13 <!entity % p-stable "IGNORE">
14 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
15 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
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 1.27 2002/04/08 15:31:18 hal9 Exp $
26 Written by and Copyright (C) 2001 the SourceForge
27 Privoxy team. http://www.privoxy.org/
29 Based on the Internet Junkbuster originally written
30 by and Copyright (C) 1997 Anonymous Coders and
31 Junkbusters Corporation. http://www.junkbusters.com
34 ========================================================================
35 NOTE: Please read developer-manual/documentation.html before touching
36 anything in this, or other Privoxy documentation. You have been warned!
37 Failure to abide by this rule will result in the revocation of your license
38 to live a peaceful existence!
39 ========================================================================
45 <title>Privoxy Developer Manual</title>
47 <pubdate>$Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:18 hal9 Exp $</pubdate>
52 <orgname>By: Privoxy Developers</orgname>
61 This is here to keep vim syntax file from breaking :/
62 If I knew enough to fix it, I would.
63 PLEASE DO NOT REMOVE! HB: hal@foobox.net
68 The developer manual gives the users information on how to help the developer
69 team. It provides guidance on coding, testing, documentation and other
73 <!-- Include privoxy.sgml boilerplate text: -->
77 <!-- end boilerplate -->
80 You can find the latest version of the this manual at <ulink
81 url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
82 Please see the Contact section on how to contact the developers.
86 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
92 <!-- ~~~~~ New section ~~~~~ -->
93 <sect1 id="intro" label=""><title></title>
94 <!-- dummy section to force TOC on page by itself -->
95 <!-- DO NOT REMOVE! please ;) -->
99 <!-- ~~~~~ New section ~~~~~ -->
102 <!-- ~~~~~ New section ~~~~~ -->
103 <sect1 label="1" id="introduction"><title>Introduction</title>
106 I don't like seeing blank space :) So added *something* here.
110 <application>Privoxy</application>, as an heir to
111 <application>Junkbuster</application>, is an Open Source project
112 and licensed under the GPL. As such, <application>Privoxy</application>
113 development is potentially open to anyone who has the time, knowledge,
114 and desire to contribute in any capacity. Our goals are simply to
115 continue the mission, to improve <application>Privoxy</application>, and
116 to make it available to as wide an audience as possible.
119 One does not have to be a programmer to contribute. Packaging, testing,
120 and porting, are all important jobs as well.
124 <!-- ~~~~~ New section ~~~~~ -->
125 <sect1 id="quickstart"><title>Quickstart to Privoxy Development</title>
127 You'll need an account on <ulink
128 url="http://sourceforge.net">Sourceforge</ulink> to support our development.
129 Mail your ID to the list and wait until a project manager has added you.
133 For the time being (read, this section is under construction), please note the
134 following guidelines for changing stuff in the code. If it is
135 <orderedlist numeration="arabic">
137 A bugfix / clean-up / cosmetic thing: shoot
140 A new feature that can be turned off: shoot
143 A clear improvement w/o side effects on other parts of the code: shoot
146 A matter of taste: ask the list
149 A major redesign of some part of the code: ask the list
155 <!-- ~~~~~ New section ~~~~~ -->
156 <sect1 id="documentation"><title>Documentation Guidelines</title>
158 All formal documents are maintained in docbook SGML and located in the
159 <computeroutput>doc/source/*</computeroutput> directory. You will need
160 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
161 DTD's and the Docbook modular stylesheets (or comparable alternatives),
162 and either <application>jade</application> or
163 <application>openjade</application> (recommended) installed in order to
164 build docs from source. Currently there is <ulink
165 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
166 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
167 course this, the <citetitle>developer-manual</citetitle> in this format.
168 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>
169 <citetitle>privoxy.1</citetitle> (man page) files are also now maintained
170 as Docbook SGML. The finished files are all in the top-level source
171 directory are generated files! Also, <filename>index.html</filename>, the
172 <application>Privoxy</application> home page, is maintained as SGML.
173 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
174 contact someone involved in the documentation (at present Stefan and
178 Other, less formal documents (e.g. <filename>LICENSE</filename>,
179 <filename>INSTALL</filename>) are maintained as plain text files in the
180 toplevel source directory. At least for the time being.
183 Packagers are encouraged to include this documentation. For those without
184 the ability to build the docs locally, text versions of each are kept in
185 CVS. HTML versions are also now being kept in CVS under
186 <filename>doc/webserver/*</filename>.
189 Formal documents are built with the Makefile targets of
190 <computeroutput>make dok</computeroutput>, or alternately
191 <computeroutput>make redhat-dok</computeroutput>. If you have problems,
192 try both. The build process uses the document SGML sources in
193 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
194 <computeroutput>doc/text/</computeroutput> and to update all HTML
195 documents in <computeroutput>doc/webserver/</computeroutput>.
198 Documentation writers should please make sure documents build
199 successfully before committing to CVS.
202 How do you update the webserver (i.e. the pages on privoxy.org)?
204 <orderedlist numeration="arabic">
206 First, build the docs by running <computeroutput>make
207 dok</computeroutput> (or alternately <computeroutput>make
208 redhat-dok</computeroutput>).
211 Run <computeroutput>make webserver</computeroutput> which copies all
212 files from <computeroutput>doc/webserver</computeroutput> to the
213 sourceforge webserver via scp.
219 <!-- ~~~~~ New section ~~~~~ -->
221 <title>Quickstart to Docbook and SGML</title>
223 If you are not familiar with SGML, it is a markup language similar to HTML.
224 Actually, not a mark up language per se, but a language used to define
225 markup languages. In fact, HTML is an SGML application. Both will use
226 <quote>tags</quote> to format text and other content. SGML tags can be much
227 more varied, and flexible, but do much of the same kinds of things. The tags,
228 or <quote>elements</quote>, are definable in SGML. There is no set
229 <quote>standards</quote>. Since we are using
230 <application>Docbook</application>, our tags are those that are defined by
231 <application>Docbook</application>. Much of how the finish document is
232 rendered is determined by the <quote>stylesheets</quote>.
233 The stylesheets determine how each tag gets translated to HTML, or other
238 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
239 will likely generate errors. Example: <literal><title>My
240 Title</title></literal>. They are also case-insensitive, but we
241 strongly suggest using all lower case. This keeps compatibility with
242 [Docbook] <application>XML</application>.
246 Our documents use <quote>sections</quote> for the most part. Sections
247 will be processed into HTML headers (e.g. <literal>h1</literal> for
248 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
249 will use these to also generate the Table of Contents for each doc. Our
250 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
251 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
252 entries, but <literal>sect4</literal> will not. Each section requires
253 a <literal><title></literal> element, and at least one
254 <literal><para></literal>. There is a limit of five section
255 levels in Docbook, but generally three should be sufficient for our
260 Some common elements that you likely will use:
265 <emphasis><para></para></emphasis>, paragraph delimiter. Most
266 text needs to be within paragraph elements (there are some exceptions).
269 <emphasis><emphasis></emphasis></emphasis>, the stylesheets make this
273 <emphasis><filename></filename></emphasis>, files and directories.
276 <emphasis><command></command></emphasis>, command examples.
279 <emphasis><literallayout></literllayout></emphasis>, like
280 <literal><pre></literal>, more or less.
283 <emphasis><itemizedlist></itemizdelist></emphasis>, list with bullets.
286 <emphasis><listitem></listitem></emphasis>, member of the above.
289 <emphasis><screen></screen></emphasis>, screen output, implies
290 <literal><literallayout></literal>.
293 <emphasis><ulink url="example.com"></ulink></emphasis>, like
294 HTML <literal><a></literal> tag.
297 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
302 Look at any of the existing docs for examples of all these and more.
308 <!-- ~~~~~ New section ~~~~~ -->
309 <sect2 id="docstyle">
310 <title><application>Privoxy</application> Documentation Style</title>
312 It will be easier if everyone follows a similar writing style. This
313 just makes it easier to read what someone else has written if it
314 is all done in a similar fashion.
323 All tags should be lower case.
328 Tags delimiting a <emphasis>block</emphasis> of text (even small
329 blocks) should be on their own line. Like:
335 Tags marking individual words, or few words, should be in-line:
337 Just to <emphasis>emphasize</emphasis>, some text goes here.
343 Tags should be nested and step indented for block text like: (except
350 Some text goes here in our list example.
353 </itemizedlist>
356 This makes it easier to find the text amongst the tags ;-)
361 Use white space to separate logical divisions within a document,
362 like between sections. Running everything together consistently
363 makes it harder to read and work on.
368 Do not hesitate to make comments. Comments can either use the
369 <comment> element, or the <!-- --> style comment
370 familiar from HTML. (Note in Docbook v4.x <comment> is
371 replaced by <remark>.)
376 We have an international audience. Refrain from slang, or English
377 idiosyncrasies (too many to list :).
382 Try to keep overall line lengths in source files to 80 characters or less
383 for obvious reasons. This is not always possible, with lenghty URLs for
389 Our documents are available in differing formats. Right now, they
390 are just plain text, and HTML, but PDF, and others is always a
391 future possibility. Be careful with URLs (<ulink>), and avoid
395 My favorite site is <ulink url="http://example.com">here</ulink>.
398 This will render as <quote>My favorite site is here</quote>, which is
399 not real helpful in a text doc. Better like this:
402 My favorite site is <ulink url="http://example.com">example.com</ulink>.
407 All documents should be spell checked occasionally.
408 <application>aspell</application> can check SGML with the
409 <literal>-H</literal> option. (<application>ispell</application> I think
420 <!-- ~~~~~ New section ~~~~~ -->
422 <sect2><title>Privoxy Custom Entities</title>
424 <application>Privoxy</application> documentation is using
425 a number of customized <quote>entities</quote> to facilitate
426 documentation maintenance.
429 We are using a set of <quote>boilerplate</quote> files with generic text,
430 that is used by multiple docs. This way we can write something once, and use
431 it repeatedly without having to re-write the same content over and over again.
432 If editing such a file, keep in mind that it should be
433 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
434 contexts without additional modifications.
437 We are also using what <application>Docbook</application> calls
438 <quote>internal entities</quote>. These are like variables in
439 programming. Well, sort of. For instance, we have the
440 <literal>p-version</literal> entity that contains the current
441 <application>Privoxy</application> version string. You are strongly
442 encouraged to use these where possible. Some of these obviously
443 require re-setting with each release (done by the Makefile). A sampling of
444 custom entities are listed below. See any of the main docs for examples.
451 Re-cyclable <quote>boilerplate</quote> text entities are defined like:
454 <literal><!entity supported SYSTEM "supported.sgml"></literal>
457 In this example, the contents of the file,
458 <filename>supported.sgml</filename> is available for inclusion anywhere
459 in the doc. To make this happen, just reference the now defined
460 entity: <literal>&supported;</literal> (starts with an ampersand
461 and ends with a semi-colon), and the contents will be dumped into
462 the finished doc at that point.
467 Commonly used <quote>internal entities</quote>:
471 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
472 version string, e.g. <quote>2.9.13</quote>.
475 <emphasis>p-status</emphasis>: the project status, either
476 <quote>ALPHA</quote>, <quote>BETA</quote>, or <quote>STABLE</quote>.
479 <emphasis>p-not-stable</emphasis>: use to conditionally include
480 text in <quote>not stable</quote> releases (e.g. <quote>BETA</quote>).
483 <emphasis>p-stable</emphasis>: just the opposite.
486 <emphasis>p-text</emphasis>: this doc is only generated as text.
493 There are others in various places that are defined for a specific
494 purpose. Read the source!
501 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
502 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
504 <!-- ~~~~~ New section ~~~~~ -->
505 <sect1 id="coding"><title>Coding Guidelines</title>
507 <sect2 id="s1"><title>Introduction</title>
509 <para>This set of standards is designed to make our lives easier. It is
510 developed with the simple goal of helping us keep the "new and improved
511 <application>Privoxy</application>" consistent and reliable. Thus making
512 maintenance easier and increasing chances of success of the
515 <para>And that of course comes back to us as individuals. If we can
516 increase our development and product efficiencies then we can solve more
517 of the request for changes/improvements and in general feel good about
518 ourselves. ;-></para>
522 <sect2 id="s2"><title>Using Comments</title>
525 <sect3 id="s3"><title>Comment, Comment, Comment</title>
527 <para><emphasis>Explanation:</emphasis></para>
529 <para>Comment as much as possible without commenting the obvious.
530 For example do not comment "aVariable is equal to bVariable".
531 Instead explain why aVariable should be equal to the bVariable.
532 Just because a person can read code does not mean they will
533 understand why or what is being done. A reader may spend a lot
534 more time figuring out what is going on when a simple comment
535 or explanation would have prevented the extra research. Please
536 help your brother IJB'ers out!</para>
538 <para>The comments will also help justify the intent of the code.
539 If the comment describes something different than what the code
540 is doing then maybe a programming error is occurring.</para>
542 <para><emphasis>Example:</emphasis></para>
544 /* if page size greater than 1k ... */
545 if ( PageLength() > 1024 )
547 ... "block" the page up ...
550 /* if page size is small, send it in blocks */
551 if ( PageLength() > 1024 )
553 ... "block" the page up ...
556 This demonstrates 2 cases of "what not to do". The first is a
557 "syntax comment". The second is a comment that does not fit what
558 is actually being done.
564 <sect3 id="s4"><title>Use blocks for comments</title>
566 <para><emphasis>Explanation:</emphasis></para>
568 <para>Comments can help or they can clutter. They help when they
569 are differentiated from the code they describe. One line
570 comments do not offer effective separation between the comment
571 and the code. Block identifiers do, by surrounding the code
572 with a clear, definable pattern.</para>
574 <para><emphasis>Example:</emphasis></para>
576 /*********************************************************************
577 * This will stand out clearly in your code!
578 *********************************************************************/
579 if ( thisVariable == thatVariable )
581 DoSomethingVeryImportant();
585 /* unfortunately, this may not */
586 if ( thisVariable == thatVariable )
588 DoSomethingVeryImportant();
592 if ( thisVariable == thatVariable ) /* this may not either */
594 DoSomethingVeryImportant();
597 <para><emphasis>Exception:</emphasis></para>
599 <para>If you are trying to add a small logic comment and do not
600 wish to "disrubt" the flow of the code, feel free to use a 1
601 line comment which is NOT on the same line as the code.</para>
607 <sect3 id="s5"><title>Keep Comments on their own line</title>
609 <para><emphasis>Explanation:</emphasis></para>
611 <para>It goes back to the question of readability. If the comment
612 is on the same line as the code it will be harder to read than
613 the comment that is on its own line.</para>
615 <para>There are three exceptions to this rule, which should be
616 violated freely and often: during the definition of variables,
617 at the end of closing braces, when used to comment
620 <para><emphasis>Example:</emphasis></para>
622 /*********************************************************************
623 * This will stand out clearly in your code,
624 * But the second example won't.
625 *********************************************************************/
626 if ( thisVariable == thatVariable )
628 DoSomethingVeryImportant();
631 if ( thisVariable == thatVariable ) /*can you see me?*/
633 DoSomethingVeryImportant(); /*not easily*/
637 /*********************************************************************
638 * But, the encouraged exceptions:
639 *********************************************************************/
640 int urls_read = 0; /* # of urls read + rejected */
641 int urls_rejected = 0; /* # of urls rejected */
645 DoSomethingVeryImportant();
649 short DoSomethingVeryImportant(
650 short firstparam, /* represents something */
651 short nextparam /* represents something else */ )
655 } /* -END- DoSomethingVeryImportant */
660 <sect3 id="s6"><title>Comment each logical step</title>
662 <para><emphasis>Explanation:</emphasis></para>
664 <para>Logical steps should be commented to help others follow the
665 intent of the written code and comments will make the code more
668 <para>If you have 25 lines of code without a comment, you should
669 probably go back into it to see where you forgot to put
672 <para>Most "for", "while", "do", etc... loops _probably_ need a
673 comment. After all, these are usually major logic
680 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
682 <para><emphasis>Explanation:</emphasis></para>
684 <para>A reader of the code should be able to look at the comments
685 just prior to the beginning of a function and discern the
686 reason for its existence and the consequences of using it. The
687 reader should not have to read through the code to determine if
688 a given function is safe for a desired use. The proper
689 information thoroughly presented at the introduction of a
690 function not only saves time for subsequent maintenance or
691 debugging, it more importantly aids in code reuse by allowing a
692 user to determine the safety and applicability of any function
693 for the problem at hand. As a result of such benefits, all
694 functions should contain the information presented in the
695 addendum section of this document.</para>
701 <sect3 id="s8"><title>Comment at the end of braces if the
702 content is more than one screen length</title>
704 <para><emphasis>Explanation:</emphasis></para>
706 <para>Each closing brace should be followed on the same line by a
707 comment that describes the origination of the brace if the
708 original brace is off of the screen, or otherwise far away from
709 the closing brace. This will simplify the debugging,
710 maintenance, and readability of the code.</para>
712 <para>As a suggestion , use the following flags to make the
713 comment and its brace more readable:</para>
715 <para>use following a closing brace: } /* -END- if() or while ()
718 <para><emphasis>Example:</emphasis></para>
722 DoSomethingVeryImportant();
723 ...some long list of commands...
724 } /* -END- if x is 1 */
730 DoSomethingVeryImportant();
731 ...some long list of commands...
732 } /* -END- if ( 1 == X ) */
738 <sect2 id="s9"><title>Naming Conventions</title>
742 <sect3 id="s10"><title>Variable Names</title>
744 <para><emphasis>Explanation:</emphasis></para>
746 <para>Use all lowercase, and seperate words via an underscore
747 ('_'). Do not start an identifier with an underscore. (ANSI C
748 reserves these for use by the compiler and system headers.) Do
749 not use identifiers which are reserved in ANSI C++. (E.g.
750 template, class, true, false, ...). This is in case we ever
751 decide to port Privoxy to C++.</para>
753 <para><emphasis>Example:</emphasis></para>
755 int ms_iis5_hack = 0;</programlisting>
757 <para><emphasis>Instead of:</emphasis></para>
761 int msiis5hack = 0; int msIis5Hack = 0;
769 <sect3 id="s11"><title>Function Names</title>
771 <para><emphasis>Explanation:</emphasis></para>
773 <para>Use all lowercase, and seperate words via an underscore
774 ('_'). Do not start an identifier with an underscore. (ANSI C
775 reserves these for use by the compiler and system headers.) Do
776 not use identifiers which are reserved in ANSI C++. (E.g.
777 template, class, true, false, ...). This is in case we ever
778 decide to port Privoxy to C++.</para>
780 <para><emphasis>Example:</emphasis></para>
782 int load_some_file( struct client_state *csp )</programlisting>
784 <para><emphasis>Instead of:</emphasis></para>
788 int loadsomefile( struct client_state *csp )
789 int loadSomeFile( struct client_state *csp )
797 <sect3 id="s12"><title>Header file prototypes</title>
799 <para><emphasis>Explanation:</emphasis></para>
801 <para>Use a descriptive parameter name in the function prototype
802 in header files. Use the same parameter name in the header file
803 that you use in the c file.</para>
805 <para><emphasis>Example:</emphasis></para>
807 (.h) extern int load_aclfile( struct client_state *csp );
808 (.c) int load_aclfile( struct client_state *csp )</programlisting>
810 <para><emphasis>Instead of:</emphasis>
812 (.h) extern int load_aclfile( struct client_state * ); or
813 (.h) extern int load_aclfile();
814 (.c) int load_aclfile( struct client_state *csp )
822 <sect3 id="s13"><title>Enumerations, and #defines</title>
824 <para><emphasis>Explanation:</emphasis></para>
826 <para>Use all capital letters, with underscores between words. Do
827 not start an identifier with an underscore. (ANSI C reserves
828 these for use by the compiler and system headers.)</para>
830 <para><emphasis>Example:</emphasis></para>
832 (enumeration) : enum Boolean { FALSE, TRUE };
833 (#define) : #define DEFAULT_SIZE 100;</programlisting>
835 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
836 that toggle a feature in the preprocessor: FEATURE_>, where
837 > is a short (preferably 1 or 2 word) description.</para>
839 <para><emphasis>Example:</emphasis></para>
841 #define FEATURE_FORCE 1
844 #define FORCE_PREFIX blah
845 #endif /* def FEATURE_FORCE */
850 <sect3 id="s14"><title>Constants</title>
852 <para><emphasis>Explanation:</emphasis></para>
854 <para>Spell common words out entirely (do not remove vowels).</para>
856 <para>Use only widely-known domain acronyms and abbreviations.
857 Capitalize all letters of an acronym.</para>
859 <para>Use underscore (_) to separate adjacent acronyms and
860 abbreviations. Never terminate a name with an underscore.</para>
862 <para><emphasis>Example:</emphasis></para>
864 #define USE_IMAGE_LIST 1</programlisting>
866 <para><emphasis>Instead of:</emphasis></para>
870 #define USE_IMG_LST 1 or
871 #define _USE_IMAGE_LIST 1 or
872 #define USE_IMAGE_LIST_ 1 or
873 #define use_image_list 1 or
874 #define UseImageList 1
884 <sect2 id="s15"><title>Using Space</title>
888 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
890 <para><emphasis>Explanation:</emphasis></para>
892 <para>The brace needs to be on a line all by itself, not at the
893 end of the statement. Curly braces should line up with the
894 construct that they're associated with. This practice makes it
895 easier to identify the opening and closing braces for a
898 <para><emphasis>Example:</emphasis></para>
905 <para><emphasis>Instead of:</emphasis></para>
907 <para>if ( this == that ) { ... }</para>
911 <para>if ( this == that ) { ... }</para>
913 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
914 inside a loop, and it is trivial, i.e. it tests for a
915 condidtion that is obvious from the purpose of the block,
916 one-liners as above may optically preserve the loop structure
917 and make it easier to read.</para>
919 <para><emphasis>Status:</emphasis> developer-discrection.</para>
921 <para><emphasis>Example exception:</emphasis></para>
923 while ( more lines are read )
925 /* Please document what is/is not a comment line here */
926 if ( it's a comment ) continue;
928 do_something( line );
934 <sect3 id="s17"><title>ALL control statements should have a
937 <para><emphasis>Explanation:</emphasis></para>
939 <para>Using braces to make a block will make your code more
940 readable and less prone to error. All control statements should
941 have a block defined.</para>
943 <para><emphasis>Example:</emphasis></para>
951 <para><emphasis>Instead of:</emphasis></para>
953 <para>if ( this == that ) DoSomething(); DoSomethingElse();</para>
957 <para>if ( this == that ) DoSomething();</para>
959 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
960 in a manner other than that which the developer desired (per
961 indentation). Using code braces would have prevented this
962 "feature". The "explanation" and "exception" from the point
963 above also applies.</para>
969 <sect3 id="s18"><title>Do not belabor/blow-up boolean
972 <para><emphasis>Example:</emphasis></para>
974 structure->flag = ( condition );</programlisting>
976 <para><emphasis>Instead of:</emphasis></para>
978 <para>if ( condition ) { structure->flag = 1; } else {
979 structure->flag = 0; }</para>
981 <para><emphasis>Note:</emphasis> The former is readable and consice. The later
982 is wordy and inefficient. Please assume that any developer new
983 to the project has at least a "good" knowledge of C/C++. (Hope
984 I do not offend by that last comment ... 8-)</para>
990 <sect3 id="s19"><title>Use white space freely because it is
993 <para><emphasis>Explanation:</emphasis></para>
995 <para>Make it readable. The notable exception to using white space
996 freely is listed in the next guideline.</para>
998 <para><emphasis>Example:</emphasis></para>
1002 int anotherValue = 0;
1003 int thisVariable = 0;
1005 if ( thisVariable == thatVariable )
1007 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
1012 <sect3 id="s20"><title>Don't use white space around structure
1015 <para><emphasis>Explanation:</emphasis></para>
1017 <para>- structure pointer operator ( "->" ) - member operator (
1018 "." ) - functions and parentheses</para>
1020 <para>It is a general coding practice to put pointers, references,
1021 and function parentheses next to names. With spaces, the
1022 connection between the object and variable/function name is not
1025 <para><emphasis>Example:</emphasis></para>
1029 FunctionName();</programlisting>
1031 <para><emphasis>Instead of:</emphasis> aStruct -> aMember; aStruct . aMember;
1032 FunctionName ();</para>
1038 <sect3 id="s21"><title>Make the last brace of a function stand
1041 <para><emphasis>Example:</emphasis></para>
1043 int function1( ... )
1048 } /* -END- function1 */
1051 int function2( ... )
1053 } /* -END- function2 */
1056 <para><emphasis>Instead of:</emphasis></para>
1058 <para>int function1( ... ) { ...code... return( retCode ); } int
1059 function2( ... ) { }</para>
1061 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1062 lines afterwards. This makes the end of function standout to
1063 the most casual viewer. Although function comments help
1064 seperate functions, this is still a good coding practice. In
1065 fact, I follow these rules when using blocks in "for", "while",
1066 "do" loops, and long if {} statements too. After all whitespace
1069 <para><emphasis>Status:</emphasis> developer-discrection on the number of blank
1070 lines. Enforced is the end of function comments.</para>
1076 <sect3 id="s22"><title>Use 3 character indentions</title>
1078 <para><emphasis>Explanation:</emphasis></para>
1080 <para>If some use 8 character TABs and some use 3 character TABs,
1081 the code can look *very* ragged. So use 3 character indentions
1082 only. If you like to use TABs, pass your code through a filter
1083 such as "expand -t3" before checking in your code.</para>
1085 <para><emphasis>Example:</emphasis></para>
1087 static const char * const url_code_map[256] =
1093 int function1( ... )
1097 return( ALWAYS_TRUE );
1101 return( HOW_DID_YOU_GET_HERE );
1104 return( NEVER_GETS_HERE );
1113 <sect2 id="s23"><title>Initializing</title>
1117 <sect3 id="s24"><title>Initialize all variables</title>
1119 <para><emphasis>Explanation:</emphasis></para>
1121 <para>Do not assume that the variables declared will not be used
1122 until after they have been assigned a value somewhere else in
1123 the code. Remove the chance of accidentally using an unassigned
1126 <para><emphasis>Example:</emphasis></para>
1130 struct *ptr = NULL;</programlisting>
1132 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1133 message says you are trying to access memory address 00000000
1134 and not 129FA012; or arrayPtr[20] causes a SIGSEV vs.
1137 <para><emphasis>Status:</emphasis> developer-discrection if and only if the
1138 variable is assigned a value "shortly after" declaration.</para>
1144 <sect2 id="s25"><title>Functions</title>
1148 <sect3 id="s26"><title>Name functions that return a boolean as a
1151 <para><emphasis>Explanation:</emphasis></para>
1153 <para>Value should be phrased as a question that would logically
1154 be answered as a true or false statement</para>
1156 <para><emphasis>Example:</emphasis></para>
1158 ShouldWeBlockThis();
1165 <sect3 id="s27"><title>Always specify a return type for a
1168 <para><emphasis>Explanation:</emphasis></para>
1170 <para>The default return for a function is an int. To avoid
1171 ambiguity, create a return for a function when the return has a
1172 purpose, and create a void return type if the function does not
1173 need to return anything.</para>
1179 <sect3 id="s28"><title>Minimize function calls when iterating by
1180 using variables</title>
1182 <para><emphasis>Explanation:</emphasis></para>
1184 <para>It is easy to write the following code, and a clear argument
1185 can be made that the code is easy to understand:</para>
1187 <para><emphasis>Example:</emphasis></para>
1189 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
1194 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1195 each and every iteration. This increases the overhead in the
1196 program, because the compiler has to look up the function each
1197 time, call it, and return a value. Depending on what occurs in
1198 the blockListLength() call, it might even be creating and
1199 destroying structures with each iteration, even though in each
1200 case it is comparing "cnt" to the same value, over and over.
1201 Remember too - even a call to blockListLength() is a function
1202 call, with the same overhead.</para>
1204 <para>Instead of using a function call during the iterations,
1205 assign the value to a variable, and evaluate using the
1208 <para><emphasis>Example:</emphasis></para>
1210 size_t len = blockListLength();
1212 for ( size_t cnt = 0; cnt < len; cnt ++ )
1217 <para><emphasis>Exceptions:</emphasis> if the value of blockListLength() *may*
1218 change or could *potentially* change, then you must code the
1219 function call in the for/while loop.</para>
1225 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1227 <para><emphasis>Explanation:</emphasis></para>
1229 <para>This allows a developer to define a const pointer and call
1230 your function. If your function does not have the const
1231 keyword, we may not be able to use your function. Consider
1232 strcmp, if it were defined as: extern int strcmp( char *s1,
1235 <para>I could then not use it to compare argv's in main: int main(
1236 int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
1239 <para>Both these pointers are *const*! If the c runtime library
1240 maintainers do it, we should too.</para>
1246 <sect3 id="s30"><title>Pass and Return by Value</title>
1248 <para><emphasis>Explanation:</emphasis></para>
1250 <para>Most structures cannot fit onto a normal stack entry (i.e.
1251 they are not 4 bytes or less). Aka, a function declaration
1252 like: int load_aclfile( struct client_state csp )</para>
1254 <para>would not work. So, to be consistent, we should declare all
1255 prototypes with "pass by value": int load_aclfile( struct
1256 client_state *csp )</para>
1262 <sect3 id="s31"><title>Names of include files</title>
1264 <para><emphasis>Explanation:</emphasis></para>
1266 <para>Your include statements should contain the file name without
1267 a path. The path should be listed in the Makefile, using -I as
1268 processor directive to search the indicated paths. An exception
1269 to this would be for some proprietary software that utilizes a
1270 partial path to distinguish their header files from system or
1271 other header files.</para>
1273 <para><emphasis>Example:</emphasis></para>
1275 #include <iostream.h> /* This is not a local include */
1276 #include "config.h" /* This IS a local include */
1279 <para><emphasis>Exception:</emphasis></para>
1283 /* This is not a local include, but requires a path element. */
1284 #include <sys/fileName.h>
1288 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1289 without a _very_ good reason. This duplicates the #include
1290 "file.h" behaviour.</para>
1296 <sect3 id="s32"><title>Provide multiple inclusion
1299 <para><emphasis>Explanation:</emphasis></para>
1301 <para>Prevents compiler and linker errors resulting from
1302 redefinition of items.</para>
1304 <para>Wrap each header file with the following syntax to prevent
1305 multiple inclusions of the file. Of course, replace PROJECT_H
1306 with your file name, with "." Changed to "_", and make it
1309 <para><emphasis>Example:</emphasis></para>
1311 #ifndef PROJECT_H_INCLUDED
1312 #define PROJECT_H_INCLUDED
1314 #endif /* ndef PROJECT_H_INCLUDED */
1319 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1321 <para><emphasis>Explanation:</emphasis></para>
1323 <para>If our headers are included from C++, they must declare our
1324 functions as `extern "C"`. This has no cost in C, but increases
1325 the potential re-usability of our code.</para>
1327 <para><emphasis>Example:</emphasis></para>
1332 #endif /* def __cplusplus */
1334 ... function definitions here ...
1338 #endif /* def __cplusplus */
1343 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1344 Declaration Instead of Includes</title>
1346 <para><emphasis>Explanation:</emphasis></para>
1348 <para>Useful in headers that include pointers to other struct's.
1349 Modifications to excess header files may cause needless
1352 <para><emphasis>Example:</emphasis></para>
1354 /*********************************************************************
1355 * We're avoiding an include statement here!
1356 *********************************************************************/
1358 extern file_list *xyz;</programlisting>
1360 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1361 pointer), then including the proper header file is necessary.
1362 If you only want to prototype a pointer, however, the header
1363 file is unneccessary.</para>
1365 <para><emphasis>Status:</emphasis> Use with discrection.</para>
1371 <sect2 id="s35"><title>General Coding Practices</title>
1375 <sect3 id="s36"><title>Turn on warnings</title>
1377 <para><emphasis>Explanation</emphasis></para>
1379 <para>Compiler warnings are meant to help you find bugs. You
1380 should turn on as many as possible. With GCC, the switch is
1381 "-Wall". Try and fix as many warnings as possible.</para>
1387 <sect3 id="s37"><title>Provide a default case for all switch
1390 <para><emphasis>Explanation:</emphasis></para>
1392 <para>What you think is guaranteed is never really guaranteed. The
1393 value that you don't think you need to check is the one that
1394 someday will be passed. So, to protect yourself from the
1395 unknown, always have a default step in a switch statement.</para>
1397 <para><emphasis>Example:</emphasis></para>
1399 switch( hash_string( cmd ) )
1401 case hash_actions_file :
1411 ... anomly code goes here ...
1412 continue; / break; / exit( 1 ); / etc ...
1414 } /* end switch( hash_string( cmd ) ) */</programlisting>
1416 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1417 are obviously exempt from this point. Of note, most of the
1418 WIN32 code calls `DefWindowProc' after the switch statement.
1419 This API call *should* be included in a default statement.</para>
1421 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1422 as a robust programming issue. The "anomly code goes here" may
1423 be no more than a print to the STDERR stream (as in
1424 load_config). Or it may really be an ABEND condition.</para>
1426 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1432 <sect3 id="s38"><title>Try to avoid falling through cases in a
1433 switch statement.</title>
1435 <para><emphasis>Explanation:</emphasis></para>
1437 <para>In general, you will want to have a 'break' statement within
1438 each 'case' of a switch statement. This allows for the code to
1439 be more readable and understandable, and furthermore can
1440 prevent unwanted surprises if someone else later gets creative
1441 and moves the code around.</para>
1443 <para>The language allows you to plan the fall through from one
1444 case statement to another simply by omitting the break
1445 statement within the case statement. This feature does have
1446 benefits, but should only be used in rare cases. In general,
1447 use a break statement for each case statement.</para>
1449 <para>If you choose to allow fall through, you should comment both
1450 the fact of the fall through and reason why you felt it was
1457 <sect3 id="s39"><title>Use 'long' or 'short' Instead of
1460 <para><emphasis>Explanation:</emphasis></para>
1462 <para>On 32-bit platforms, int usually has the range of long. On
1463 16-bit platforms, int has the range of short.</para>
1465 <para><emphasis>Status:</emphasis> open-to-debate. In the case of most FSF
1466 projects (including X/GNU-Emacs), there are typedefs to int4,
1467 int8, int16, (or equivalence ... I forget the exact typedefs
1468 now). Should we add these to IJB now that we have a "configure"
1475 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1477 <para><emphasis>Explanation:</emphasis></para>
1479 <para>The type of size_t varies across platforms. Do not make
1480 assumptions about whether it is signed or unsigned, or about
1481 how long it is. Do not compare a size_t against another
1482 variable of a different type (or even against a constant)
1483 without casting one of the values. Try to avoid using size_t if
1490 <sect3 id="s41"><title>Declare each variable and struct on its
1493 <para><emphasis>Explanation:</emphasis></para>
1495 <para>It can be tempting to declare a series of variables all on
1496 one line. Don't.</para>
1498 <para><emphasis>Example:</emphasis></para>
1502 long c = 0;</programlisting>
1504 <para><emphasis>Instead of:</emphasis></para>
1506 <para>long a, b, c;</para>
1508 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1509 individual variables - easier to add new variables without
1510 messing up the original ones - when searching on a variable to
1511 find its type, there is less clutter to "visually"
1514 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1515 variables or other trivial variables; feel free to declare them
1516 on 1 line. You should, although, provide a good comment on
1517 their functions.</para>
1519 <para><emphasis>Status:</emphasis> developer-discrection.</para>
1525 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1527 <para><emphasis>Explanation:</emphasis></para>
1529 <para>Create a local stuct (on the stack) if the variable will
1530 live and die within the context of one function call.</para>
1532 <para>Only "malloc" a struct (on the heap) if the variable's life
1533 will extend beyond the context of one function call.</para>
1535 <para><emphasis>Example:</emphasis></para>
1537 If a function creates a struct and stores a pointer to it in a
1538 list, then it should definately be allocated via `malloc'.
1543 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1544 Responsible for Ensuring 'free'</title>
1546 <para><emphasis>Explanation:</emphasis></para>
1548 <para>If you have to "malloc" an instance, you are responsible for
1549 insuring that the instance is `free'd, even if the deallocation
1550 event falls within some other programmer's code. You are also
1551 responsible for ensuring that deletion is timely (i.e. not too
1552 soon, not too late). This is known as "low-coupling" and is a
1553 "good thing (tm)". You may need to offer a
1554 free/unload/destuctor type function to accomodate this.</para>
1556 <para><emphasis>Example:</emphasis></para>
1558 int load_re_filterfile( struct client_state *csp ) { ... }
1559 static void unload_re_filterfile( void *f ) { ... }</programlisting>
1561 <para><emphasis>Exceptions:</emphasis></para>
1563 <para>The developer cannot be expected to provide `free'ing
1564 functions for C run-time library functions ... such as
1567 <para><emphasis>Status:</emphasis> developer-discrection. The "main" use of this
1568 standard is for allocating and freeing data structures (complex
1575 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1576 and in order</title>
1578 <para><emphasis>Explanation:</emphasis></para>
1580 <para>I have ordered all of the "blocker" file code to be in alpha
1581 order. It is easier to add/read new blockers when you expect a
1582 certain order.</para>
1584 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1585 places by POPUP tests coming before PCRS tests. But since
1586 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1587 it should come first.</para>
1593 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1594 exitinst code, use FIXME</title>
1596 <para><emphasis>Explanation:</emphasis></para>
1598 <para>If you have enough confidence in new code or confidence in
1599 your changes, but are not *quite* sure of the reprocussions,
1602 <para>/* FIXME: this code has a logic error on platform XYZ, *
1603 attempthing to fix */ #ifdef PLATFORM ...changed code here...
1608 <para>/* FIXME: I think the original author really meant this...
1609 */ ...changed code here...</para>
1613 <para>/* FIXME: new code that *may* break something else... */
1614 ...new code here...</para>
1616 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1617 be a "good thing (tm)", it will be easier to identify and
1618 include in the project (or conversly exclude from the
1626 <sect2 id="s46"><title>Addendum: Template for files and function
1627 comment blocks:</title>
1629 <para><emphasis>Example for file comments:</emphasis></para>
1631 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:18 hal9 Exp $";
1632 /*********************************************************************
1634 * File : $S<!-- Break CVS Substitution -->ource$
1636 * Purpose : (Fill me in with a good description!)
1638 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1639 * Privoxy team. http://www.privoxy.org/
1641 * Based on the Internet Junkbuster originally written
1642 * by and Copyright (C) 1997 Anonymous Coders and
1643 * Junkbusters Corporation. http://www.junkbusters.com
1645 * This program is free software; you can redistribute it
1646 * and/or modify it under the terms of the GNU General
1647 * Public License as published by the Free Software
1648 * Foundation; either version 2 of the License, or (at
1649 * your option) any later version.
1651 * This program is distributed in the hope that it will
1652 * be useful, but WITHOUT ANY WARRANTY; without even the
1653 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1654 * PARTICULAR PURPOSE. See the GNU General Public
1655 * License for more details.
1657 * The GNU General Public License should be included with
1658 * this file. If not, you can view it at
1659 * http://www.gnu.org/copyleft/gpl.html
1660 * or write to the Free Software Foundation, Inc., 59
1661 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1664 * $L<!-- Break CVS Substitution -->og$
1666 *********************************************************************/
1671 ...necessary include files for us to do our work...
1673 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1676 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1677 added to the "show-proxy-args" page. If this is a brand new
1678 creation by you, you are free to change the "Copyright" section
1679 to represent the rights you wish to maintain.</para>
1681 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1682 after the comment flower box is handy for (X|GNU)Emacs users to
1683 skip the verbige and get to the heart of the code (via
1684 `forward-page' and `backward-page'). Please include it if you
1687 <para><emphasis>Example for file header comments:</emphasis></para>
1691 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:18 hal9 Exp $"
1692 /*********************************************************************
1694 * File : $S<!-- Break CVS Substitution -->ource$
1696 * Purpose : (Fill me in with a good description!)
1698 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1699 * Privoxy team. http://www.privoxy.org/
1701 * Based on the Internet Junkbuster originally written
1702 * by and Copyright (C) 1997 Anonymous Coders and
1703 * Junkbusters Corporation. http://www.junkbusters.com
1705 * This program is free software; you can redistribute it
1706 * and/or modify it under the terms of the GNU General
1707 * Public License as published by the Free Software
1708 * Foundation; either version 2 of the License, or (at
1709 * your option) any later version.
1711 * This program is distributed in the hope that it will
1712 * be useful, but WITHOUT ANY WARRANTY; without even the
1713 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1714 * PARTICULAR PURPOSE. See the GNU General Public
1715 * License for more details.
1717 * The GNU General Public License should be included with
1718 * this file. If not, you can view it at
1719 * http://www.gnu.org/copyleft/gpl.html
1720 * or write to the Free Software Foundation, Inc., 59
1721 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1724 * $L<!-- Break CVS Substitution -->og$
1726 *********************************************************************/
1729 #include "project.h"
1735 ... function headers here ...
1738 /* Revision control strings from this header and associated .c file */
1739 extern const char FILENAME_rcs[];
1740 extern const char FILENAME_h_rcs[];
1747 #endif /* ndef _FILENAME_H */
1756 <para><emphasis>Example for function comments:</emphasis></para>
1758 /*********************************************************************
1760 * Function : FUNCTION_NAME
1762 * Description : (Fill me in with a good description!)
1765 * 1 : param1 = pointer to an important thing
1766 * 2 : x = pointer to something else
1768 * Returns : 0 => Ok, everything else is an error.
1770 *********************************************************************/
1771 int FUNCTION_NAME( void *param1, const char *x )
1779 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1780 able to parse our code to create a "self-documenting" web
1787 <!-- ~~~~~ New section ~~~~~ -->
1788 <sect1 id="cvs"><title>Version Control Guidelines</title>
1789 <para>To be filled. note on cvs comments. Don't only comment what you did,
1790 but also why you did it!
1794 <!-- ~~~~~ New section ~~~~~ -->
1795 <sect1 id="testing"><title>Testing Guidelines</title>
1799 <!-- ~~~~~ New section ~~~~~ -->
1800 <sect2 id="testing-plan"><title>Testplan for releases</title>
1802 Explain release numbers. major, minor. developer releases. etc.
1804 <orderedlist numeration="arabic">
1806 Remove any existing rpm with rpm -e
1809 Remove any file that was left over. This includes (but is not limited to)
1811 <listitem><para>/var/log/privoxy</para></listitem>
1812 <listitem><para>/etc/privoxy</para></listitem>
1813 <listitem><para>/usr/sbin/privoxy</para></listitem>
1814 <listitem><para>/etc/init.d/privoxy</para></listitem>
1815 <listitem><para>/usr/doc/privoxy*</para></listitem>
1819 Install the rpm. Any error messages?
1821 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1822 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1823 autostart work?</para></listitem>
1824 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1825 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1830 <!-- ~~~~~ New section ~~~~~ -->
1831 <sect2 id="testing-report"><title>Test reports</title>
1833 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
1834 at sourceforge. Three simple steps:
1837 <listitem><para>Select category: the distribution you test on.</para></listitem>
1838 <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
1839 <listitem><para>Fill the Summary and Detailed Description with something
1840 intelligent (keep it short and precise).</para>
1843 Do not mail to the mailinglist (we cannot keep track on issues there).
1849 <!-- ~~~~~ New section ~~~~~ -->
1850 <sect1 id="newrelease"><title>Releasing a new version</title>
1852 To minimize trouble with distribution contents, webpage
1853 errors and the like, we strongly encourage you
1854 to follow this section if you prepare a new release of
1855 code or new pages on the webserver.
1858 The following programs are required to follow this process:
1859 <filename>ncftpput</filename> (ncftp), <filename>scp</filename> (ssh),
1860 <filename>gmake</filename> (GNU's version of make), autoconf, cvs, ???.
1863 <sect2 id="beforerelease">
1864 <title>Before the Release</title>
1866 The following <emphasis>must be done by one of the
1867 developers</emphasis> prior to each new release:
1873 Make sure that everybody who has worked on the code in the last
1874 couple of days has had a chance to yell <quote>no!</quote> in case
1875 they have pending changes/fixes in their pipelines.
1880 Increment the version number in <filename>configure.in</filename> in
1881 CVS. Also, the RPM release number in
1882 <filename>configure.in</filename>. Do NOT touch version information
1883 after export from CVS. <emphasis>All packages</emphasis> will use the
1884 version and release data from <filename>configure.in</filename>.
1885 Local files should not be changed, except prior to a CVS commit!!!
1886 This way we are all on the same page!
1891 If the default actionsfile has changed since last release,
1892 bump up its version info in this line:
1896 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
1900 Then change the version info in doc/webserver/actions/index.php,
1901 line: '$required_actions_file_version = "A.B";'
1906 Tag all files in CVS with the version number with
1907 <quote><command>cvs tag v_X_Y_Z</command></quote> (where X = major, Y
1908 = minor, Z = point). Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work)
1914 The first package uploaded should be the official
1915 <quote>tarball</quote> release. This is built with the
1916 <quote><command>make tarball-dist</command></quote> Makefile
1917 target, and then can be uploaded with
1918 <quote><command>make tarball-upload</command></quote> (see below).
1925 <sect2 id="newrelease-web"><title>Update the webserver</title>
1927 All files must be group-readable and group-writable (or no one else
1928 will be able to change them). To update the webserver, create any
1929 pages locally in the <filename>doc/webserver</filename> directory (or
1930 create new directories under <filename>doc/webserver</filename>), then do
1938 Note that <quote><command>make dok</command></quote>
1939 (or <quote><command>make redhat-dok</command></quote>) creates
1940 <filename>doc/webserver/user-manual</filename>,
1941 <filename>doc/webserver/developer-manual</filename>,
1942 <filename>doc/webserver/faq</filename> and
1943 <filename>doc/webserver/man-page</filename> automatically.
1946 Please do NOT use any other means of transferring files to the
1947 webserver. <quote><command>make webserver</command></quote> not only
1948 uploads, but will make sure that the appropriate permissions are
1949 preserved for shared group access.
1953 <sect2 id="newrelease-rpm"><title>SuSE or Red Hat</title>
1955 Ensure that you have the latest code version. Hence run:
1960 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1961 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1969 autoheader && autoconf && ./configure
1977 make suse-dist or make redhat-dist
1981 To upload the package to Sourceforge, simply issue
1985 make suse-upload or make redhat-upload
1989 Go to the displayed URL and release the file publicly on Sourceforge.
1993 <sect2 id="newrelease-os2"><title>OS/2</title>
1995 Ensure that you have the latest code version. Hence run:
2000 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2001 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2003 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
2007 You will need a mix of development tools.
2008 The main compilation takes place with IBM Visual Age C++.
2009 Some ancillary work takes place with GNU tools, available from
2010 various sources like hobbes.nmsu.edu.
2011 Specificially, you will need <filename>autoheader</filename>,
2012 <filename>autoconf</filename> and <filename>sh</filename> tools.
2013 The packaging takes place with WarpIN, available from various sources, including
2014 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2017 Change directory to the <filename>os2setup</filename> directory.
2018 Edit the os2build.cmd file to set the final executable filename.
2021 installExeName='privoxyos2_setup_X.Y.Z.exe'
2023 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2024 in the <filename>PACKAGEID</filename> section:
2026 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2028 You're now ready to build. Run:
2032 And in the <filename>./files</filename> directory you will have the
2033 WarpIN-installable executable.
2034 Upload this anonymously to
2035 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2036 for it, and you're done.
2040 <sect2 id="newrelease-solaris"><title>Solaris</title>
2042 Login to Sourceforge's compilefarm via ssh
2046 ssh cf.sourceforge.net
2050 Choose the right operating system (not the Debian one). If you have
2051 downloaded <application>Privoxy</application> before,
2056 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2057 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2061 If not, please <ulink
2062 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
2063 Privoxy via CVS first</ulink>. Run:
2067 autoheader && autoconf && ./configure
2079 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2080 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2081 to manually upload the archive to Sourceforge's ftp server and release
2086 <sect2 id="newrelease-windows"><title>Windows</title>
2088 Ensure that you have the latest code version. Hence run
2093 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2094 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2102 autoheader && autoconf && ./configure
2110 <sect2 id="newrelease-debian"><title>Debian</title>
2112 Ensure that you have the latest code version. Hence run:
2117 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2118 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2126 autoheader && autoconf && ./configure
2134 <sect2 id="newrelease-macosx"><title>Mac OSX</title>
2136 Ensure that you have the latest code version. Hence run:
2141 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2142 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2144 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
2148 From the osxsetup directory, run:
2154 This will run <filename>autoheader</filename>, <filename>autoconf</filename> and
2155 <filename>configure</filename> as well as <filename>make</filename>.
2156 Finally, it will copy over the necessary files to the ./osxsetup/files directory
2157 for further processing by <filename>PackageMaker</filename>.
2160 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
2161 name to match the release, and hit the "Create package" button.
2162 If you specify ./Privoxy.pkg as the output package name, you can then create
2163 the distributable zip file with the command:
2165 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2167 You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to
2168 <filename>uploads.sourceforge.net/incoming</filename>,
2169 create a release for it, and you're done.
2173 <sect2 id="newrelease-freebsd"><title>FreeBSD</title>
2175 Change the version number of <application>Privoxy</application> in the
2176 configure.in file. Run:
2178 autoheader && autoconf && ./configure
2183 Login to Sourceforge's compilefarm via ssh:
2187 ssh cf.sourceforge.net
2191 Choose the right operating system. If you have downloaded Privoxy
2197 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2198 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2202 If not, please <ulink
2203 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
2204 Privoxy via CVS first</ulink>. Run:
2208 autoheader && autoconf && ./configure
2220 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2221 freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
2222 to manually upload the archive to Sourceforge's ftp server and release
2227 <sect2 id="newrelease-tarball"><title>Tarball</title>
2229 Ensure that you have the latest code version. Hence run:
2234 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2235 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2244 autoheader && autoconf && ./configure
2256 To upload the package to Sourceforge, simply issue
2264 Goto the displayed URL and release the file publicly on Sourceforge.
2268 <sect2 id="newrelease-hpux"><title>HP-UX 11</title>
2270 Ensure that you have the latest code version. Hence run:
2275 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2276 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2284 autoheader && autoconf && ./configure
2292 <sect2 id="newrelease-amiga"><title>Amiga OS</title>
2294 Ensure that you have the latest code version. Hence run:
2299 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2300 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2308 autoheader && autoconf && ./configure
2316 <sect2 id="newrelease-aix"><title>AIX</title>
2318 Login to Sourceforge's compilefarm via ssh:
2322 ssh cf.sourceforge.net
2326 Choose the right operating system. If you have downloaded Privoxy
2332 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2333 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2337 If not, please <ulink
2338 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
2339 Privoxy via CVS first</ulink>. Run:
2343 autoheader && autoconf && ./configure
2355 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2356 aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
2357 to manually upload the archive to Sourceforge's ftp server and release
2364 <!-- ~~~~~ New section ~~~~~ -->
2365 <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
2366 <!-- Include contacting.sgml -->
2368 <!-- end contacting -->
2371 <!-- ~~~~~ New section ~~~~~ -->
2372 <sect1 id="copyright"><title>Copyright and History</title>
2374 <sect2><title>Copyright</title>
2375 <!-- Include copyright.sgml -->
2380 <sect2><title>History</title>
2381 <!-- Include history.sgml -->
2388 <!-- ~~~~~ New section ~~~~~ -->
2389 <sect1 id="seealso"><title>See also</title>
2390 <!-- Include seealso.sgml -->
2398 This program is free software; you can redistribute it
2399 and/or modify it under the terms of the GNU General
2400 Public License as published by the Free Software
2401 Foundation; either version 2 of the License, or (at
2402 your option) any later version.
2404 This program is distributed in the hope that it will
2405 be useful, but WITHOUT ANY WARRANTY; without even the
2406 implied warranty of MERCHANTABILITY or FITNESS FOR A
2407 PARTICULAR PURPOSE. See the GNU General Public
2408 License for more details.
2410 The GNU General Public License should be included with
2411 this file. If not, you can view it at
2412 http://www.gnu.org/copyleft/gpl.html
2413 or write to the Free Software Foundation, Inc., 59
2414 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2416 $Log: developer-manual.sgml,v $
2417 Revision 1.27 2002/04/08 15:31:18 hal9
2418 Touch ups to documentation section.
2420 Revision 1.26 2002/04/07 23:50:08 hal9
2421 Documentation changes to reflect HTML docs now in CVS, and new generated files
2424 Revision 1.25 2002/04/06 05:07:28 hal9
2425 -Add privoxy-man-page.sgml, for man page.
2426 -Add authors.sgml for AUTHORS (and p-authors.sgml)
2427 -Reworked various aspects of various docs.
2428 -Added additional comments to sub-docs.
2430 Revision 1.24 2002/04/04 21:33:37 hal9
2431 More on documenting the documents.
2433 Revision 1.23 2002/04/04 18:46:47 swa
2434 consistent look. reuse of copyright, history et. al.
2436 Revision 1.22 2002/04/04 17:27:56 swa
2437 more single file to be included at multiple points. make maintaining easier
2439 Revision 1.21 2002/04/04 06:48:37 hal9
2440 Structural changes to allow for conditional inclusion/exclusion of content
2441 based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
2442 definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
2443 eventually be set by Makefile.
2444 More boilerplate text for use across multiple docs.
2446 Revision 1.20 2002/04/04 03:28:27 david__schmidt
2449 Revision 1.19 2002/04/03 15:09:42 david__schmidt
2450 Add OS/2 build section
2452 Revision 1.18 2002/04/03 03:51:48 hal9
2455 Revision 1.17 2002/04/03 01:21:17 hal9
2456 Implementing Andreas's suggestions for Release sections.
2458 Revision 1.16 2002/03/31 23:04:40 hal9
2459 Fleshed out the doc section, and added something for an intro so it was not
2462 Revision 1.15 2002/03/30 22:29:47 swa
2465 Revision 1.14 2002/03/30 19:04:08 swa
2466 people release differently. no good.
2467 I want to make parts of the docs only.
2469 Revision 1.13 2002/03/27 01:16:41 hal9
2472 Revision 1.12 2002/03/27 01:02:51 hal9
2473 Touch up on name change...
2475 Revision 1.11 2002/03/26 22:29:55 swa
2476 we have a new homepage!
2478 Revision 1.10 2002/03/24 12:33:01 swa
2481 Revision 1.9 2002/03/24 11:01:05 swa
2484 Revision 1.8 2002/03/23 15:13:11 swa
2485 renamed every reference to the old name with foobar.
2486 fixed "application foobar application" tag, fixed
2487 "the foobar" with "foobar". left junkbustser in cvs
2488 comments and remarks to history untouched.
2490 Revision 1.7 2002/03/11 13:13:27 swa
2491 correct feedback channels
2493 Revision 1.6 2002/02/24 14:25:06 jongfoster
2494 Formatting changes. Now changing the doctype to DocBook XML 4.1
2495 will work - no other changes are needed.
2497 Revision 1.5 2001/10/31 18:16:51 swa
2498 documentation added: howto generate docs in text and html
2499 format, howto move stuff to the webserver.
2501 Revision 1.4 2001/09/23 10:13:48 swa
2502 upload process established. run make webserver and
2503 the documentation is moved to the webserver. documents
2504 are now linked correctly.
2506 Revision 1.3 2001/09/13 15:27:40 swa
2509 Revision 1.2 2001/09/13 15:20:17 swa
2510 merged standards into developer manual
2512 Revision 1.1 2001/09/12 15:36:41 swa
2513 source files for junkbuster documentation
2515 Revision 1.3 2001/09/10 17:43:59 swa
2516 first proposal of a structure.
2518 Revision 1.2 2001/06/13 14:28:31 swa
2519 docs should have an author.
2521 Revision 1.1 2001/06/13 14:20:37 swa
2522 first import of project's documentation for the webserver.