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 p-version "2.9.13">
7 <!entity p-status "BETA">
8 <!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release -->
9 <!entity % p-stable "IGNORE"> <!-- set INCLUDE for stable release -->
10 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
11 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
14 File : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
16 Purpose : developer manual
17 This file belongs into
18 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
20 $Id: developer-manual.sgml,v 1.20 2002/04/04 03:28:27 david__schmidt Exp $
22 Written by and Copyright (C) 2001 the SourceForge
23 Privoxy team. http://www.privoxy.org/
25 Based on the Internet Junkbuster originally written
26 by and Copyright (C) 1997 Anonymous Coders and
27 Junkbusters Corporation. http://www.junkbusters.com
32 <title>Privoxy Developer Manual</title>
34 <pubdate>$Id: developer-manual.sgml,v 1.20 2002/04/04 03:28:27 david__schmidt Exp $</pubdate>
39 <orgname>By: Privoxy Developers</orgname>
48 This is here to keep vim syntax file from breaking :/
49 If I knew enough to fix it, I would.
50 PLEASE DO NOT REMOVE! HB: hal@foobox.net
55 The developer manual gives the users information on how to help the developer
56 team. It provides guidance on coding, testing, documentation and other
60 <!-- Include privoxy.sgml boilerplate text: -->
64 <!-- end boilerplate -->
67 You can find the latest version of the this manual at <ulink
68 url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
69 Please see the Contact section of the <ulink
70 url="../user-manual/contact.html">User Manual</ulink> on how to contact the
75 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
81 <!-- ~~~~~ New section ~~~~~ -->
82 <sect1 id="introduction"><title>Introduction</title>
85 I don't like seeing blank space :) So added *something* here.
89 <application>Privoxy</application>, as an heir to
90 <application>Junkbuster</application>, is an Open Source project
91 and licensed under the GPL. As such, <application>Privoxy</application>
92 development is potentially open to anyone who has the time, knowledge,
93 and desire to contribute in any capacity. Our goals are simply to
94 continue the mission, to improve <application>Privoxy</application>, and
95 to make it available to as wide an audience as possible.
98 One does not have to be a programmer to contribute. Packaging, testing,
99 and porting, are all important jobs as well.
103 <!-- ~~~~~ New section ~~~~~ -->
104 <sect1 id="quickstart"><title>Quickstart to Privoxy Development</title>
106 You'll need an account on <ulink
107 url="http://sourceforge.net">Sourceforge</ulink> to support our development.
108 Mail your ID to the list and wait until a project manager has added you.
112 For the time being (read, this section is under construction), please note the
113 following guidelines for changing stuff in the code. If it is
114 <orderedlist numeration="arabic">
116 A bugfix / clean-up / cosmetic thing: shoot
119 A new feature that can be turned off: shoot
122 A clear improvement w/o side effects on other parts of the code: shoot
125 A matter of taste: ask the list
128 A major redesign of some part of the code: ask the list
134 <!-- ~~~~~ New section ~~~~~ -->
135 <sect1 id="documentation"><title>Documentation Guidelines</title>
137 All formal documents are maintained in docbook SGML and located
138 in the <computeroutput>doc/source</computeroutput> directory. You will
139 need <ulink url="http://www.docbook.org">docbook</ulink> and the
140 docbook stylesheets (or comparable alternatives), and either
141 <application>jade</application> or <application>openjade</application>
142 installed in order to build docs from source. Currently there is
144 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
146 url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>,
147 and, of course this, the <citetitle>developer-manual</citetitle> in
151 Other, less formal documents (e.g. README, LICENSE) are
152 maintained as plain text files in the toplevel source
156 Packagers are encouraged to include this documentation. For those
157 without the ability to build the docs locally, text versions of
158 each are kept in CVS. Or HTML versions can be downloaded from the <ulink
159 url="http://www.privoxy.org">www.privoxy.org</ulink> website, which
160 should be fairly current.
163 Formal documents are built with the Makefile targets of
164 <computeroutput>make dok</computeroutput>, or alternately
165 <computeroutput>make redhat-dok</computeroutput>. If you
166 have problems, try both. The build process uses the document
167 SGML sources in <computeroutput>doc/source</computeroutput> to
168 update all text files in <computeroutput>doc/text</computeroutput>
169 and to update all HTML documents in
170 <computeroutput>doc/webserver</computeroutput>.
173 Documentation writers should please make sure documents build
174 successfully before committing to CVS.
177 How do you update the webserver (i.e. the pages on privoxy.org)?
178 <orderedlist numeration="arabic">
180 First, build the docs by running <computeroutput>make
181 dok</computeroutput> (or alternately <computeroutput>make
182 redhat-dok</computeroutput>).
185 Run <computeroutput>make webserver</computeroutput> which copies all files from
186 <computeroutput>doc/webserver</computeroutput> to the sourceforge webserver
193 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
194 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
196 <!-- ~~~~~ New section ~~~~~ -->
197 <sect1 id="coding"><title>Coding Guidelines</title>
199 <sect2 id="s1"><title>Introduction</title>
201 <para>This set of standards is designed to make our lives easier. It is
202 developed with the simple goal of helping us keep the "new and improved
203 <application>Privoxy</application>" consistent and reliable. Thus making
204 maintenance easier and increasing chances of success of the
207 <para>And that of course comes back to us as individuals. If we can
208 increase our development and product efficiencies then we can solve more
209 of the request for changes/improvements and in general feel good about
210 ourselves. ;-></para>
214 <sect2 id="s2"><title>Using Comments</title>
217 <sect3 id="s3"><title>Comment, Comment, Comment</title>
219 <para><emphasis>Explanation:</emphasis></para>
221 <para>Comment as much as possible without commenting the obvious.
222 For example do not comment "aVariable is equal to bVariable".
223 Instead explain why aVariable should be equal to the bVariable.
224 Just because a person can read code does not mean they will
225 understand why or what is being done. A reader may spend a lot
226 more time figuring out what is going on when a simple comment
227 or explanation would have prevented the extra research. Please
228 help your brother IJB'ers out!</para>
230 <para>The comments will also help justify the intent of the code.
231 If the comment describes something different than what the code
232 is doing then maybe a programming error is occurring.</para>
234 <para><emphasis>Example:</emphasis></para>
236 /* if page size greater than 1k ... */
237 if ( PageLength() > 1024 )
239 ... "block" the page up ...
242 /* if page size is small, send it in blocks */
243 if ( PageLength() > 1024 )
245 ... "block" the page up ...
248 This demonstrates 2 cases of "what not to do". The first is a
249 "syntax comment". The second is a comment that does not fit what
250 is actually being done.
256 <sect3 id="s4"><title>Use blocks for comments</title>
258 <para><emphasis>Explanation:</emphasis></para>
260 <para>Comments can help or they can clutter. They help when they
261 are differentiated from the code they describe. One line
262 comments do not offer effective separation between the comment
263 and the code. Block identifiers do, by surrounding the code
264 with a clear, definable pattern.</para>
266 <para><emphasis>Example:</emphasis></para>
268 /*********************************************************************
269 * This will stand out clearly in your code!
270 *********************************************************************/
271 if ( thisVariable == thatVariable )
273 DoSomethingVeryImportant();
277 /* unfortunately, this may not */
278 if ( thisVariable == thatVariable )
280 DoSomethingVeryImportant();
284 if ( thisVariable == thatVariable ) /* this may not either */
286 DoSomethingVeryImportant();
289 <para><emphasis>Exception:</emphasis></para>
291 <para>If you are trying to add a small logic comment and do not
292 wish to "disrubt" the flow of the code, feel free to use a 1
293 line comment which is NOT on the same line as the code.</para>
299 <sect3 id="s5"><title>Keep Comments on their own line</title>
301 <para><emphasis>Explanation:</emphasis></para>
303 <para>It goes back to the question of readability. If the comment
304 is on the same line as the code it will be harder to read than
305 the comment that is on its own line.</para>
307 <para>There are three exceptions to this rule, which should be
308 violated freely and often: during the definition of variables,
309 at the end of closing braces, when used to comment
312 <para><emphasis>Example:</emphasis></para>
314 /*********************************************************************
315 * This will stand out clearly in your code,
316 * But the second example won't.
317 *********************************************************************/
318 if ( thisVariable == thatVariable )
320 DoSomethingVeryImportant();
323 if ( thisVariable == thatVariable ) /*can you see me?*/
325 DoSomethingVeryImportant(); /*not easily*/
329 /*********************************************************************
330 * But, the encouraged exceptions:
331 *********************************************************************/
332 int urls_read = 0; /* # of urls read + rejected */
333 int urls_rejected = 0; /* # of urls rejected */
337 DoSomethingVeryImportant();
341 short DoSomethingVeryImportant(
342 short firstparam, /* represents something */
343 short nextparam /* represents something else */ )
347 } /* -END- DoSomethingVeryImportant */
352 <sect3 id="s6"><title>Comment each logical step</title>
354 <para><emphasis>Explanation:</emphasis></para>
356 <para>Logical steps should be commented to help others follow the
357 intent of the written code and comments will make the code more
360 <para>If you have 25 lines of code without a comment, you should
361 probably go back into it to see where you forgot to put
364 <para>Most "for", "while", "do", etc... loops _probably_ need a
365 comment. After all, these are usually major logic
372 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
374 <para><emphasis>Explanation:</emphasis></para>
376 <para>A reader of the code should be able to look at the comments
377 just prior to the beginning of a function and discern the
378 reason for its existence and the consequences of using it. The
379 reader should not have to read through the code to determine if
380 a given function is safe for a desired use. The proper
381 information thoroughly presented at the introduction of a
382 function not only saves time for subsequent maintenance or
383 debugging, it more importantly aids in code reuse by allowing a
384 user to determine the safety and applicability of any function
385 for the problem at hand. As a result of such benefits, all
386 functions should contain the information presented in the
387 addendum section of this document.</para>
393 <sect3 id="s8"><title>Comment at the end of braces if the
394 content is more than one screen length</title>
396 <para><emphasis>Explanation:</emphasis></para>
398 <para>Each closing brace should be followed on the same line by a
399 comment that describes the origination of the brace if the
400 original brace is off of the screen, or otherwise far away from
401 the closing brace. This will simplify the debugging,
402 maintenance, and readability of the code.</para>
404 <para>As a suggestion , use the following flags to make the
405 comment and its brace more readable:</para>
407 <para>use following a closing brace: } /* -END- if() or while ()
410 <para><emphasis>Example:</emphasis></para>
414 DoSomethingVeryImportant();
415 ...some long list of commands...
416 } /* -END- if x is 1 */
422 DoSomethingVeryImportant();
423 ...some long list of commands...
424 } /* -END- if ( 1 == X ) */
430 <sect2 id="s9"><title>Naming Conventions</title>
434 <sect3 id="s10"><title>Variable Names</title>
436 <para><emphasis>Explanation:</emphasis></para>
438 <para>Use all lowercase, and seperate words via an underscore
439 ('_'). Do not start an identifier with an underscore. (ANSI C
440 reserves these for use by the compiler and system headers.) Do
441 not use identifiers which are reserved in ANSI C++. (E.g.
442 template, class, true, false, ...). This is in case we ever
443 decide to port Privoxy to C++.</para>
445 <para><emphasis>Example:</emphasis></para>
447 int ms_iis5_hack = 0;</programlisting>
449 <para><emphasis>Instead of:</emphasis></para>
453 int msiis5hack = 0; int msIis5Hack = 0;
461 <sect3 id="s11"><title>Function Names</title>
463 <para><emphasis>Explanation:</emphasis></para>
465 <para>Use all lowercase, and seperate words via an underscore
466 ('_'). Do not start an identifier with an underscore. (ANSI C
467 reserves these for use by the compiler and system headers.) Do
468 not use identifiers which are reserved in ANSI C++. (E.g.
469 template, class, true, false, ...). This is in case we ever
470 decide to port Privoxy to C++.</para>
472 <para><emphasis>Example:</emphasis></para>
474 int load_some_file( struct client_state *csp )</programlisting>
476 <para><emphasis>Instead of:</emphasis></para>
480 int loadsomefile( struct client_state *csp )
481 int loadSomeFile( struct client_state *csp )
489 <sect3 id="s12"><title>Header file prototypes</title>
491 <para><emphasis>Explanation:</emphasis></para>
493 <para>Use a descriptive parameter name in the function prototype
494 in header files. Use the same parameter name in the header file
495 that you use in the c file.</para>
497 <para><emphasis>Example:</emphasis></para>
499 (.h) extern int load_aclfile( struct client_state *csp );
500 (.c) int load_aclfile( struct client_state *csp )</programlisting>
502 <para><emphasis>Instead of:</emphasis>
504 (.h) extern int load_aclfile( struct client_state * ); or
505 (.h) extern int load_aclfile();
506 (.c) int load_aclfile( struct client_state *csp )
514 <sect3 id="s13"><title>Enumerations, and #defines</title>
516 <para><emphasis>Explanation:</emphasis></para>
518 <para>Use all capital letters, with underscores between words. Do
519 not start an identifier with an underscore. (ANSI C reserves
520 these for use by the compiler and system headers.)</para>
522 <para><emphasis>Example:</emphasis></para>
524 (enumeration) : enum Boolean { FALSE, TRUE };
525 (#define) : #define DEFAULT_SIZE 100;</programlisting>
527 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
528 that toggle a feature in the preprocessor: FEATURE_>, where
529 > is a short (preferably 1 or 2 word) description.</para>
531 <para><emphasis>Example:</emphasis></para>
533 #define FEATURE_FORCE 1
536 #define FORCE_PREFIX blah
537 #endif /* def FEATURE_FORCE */
542 <sect3 id="s14"><title>Constants</title>
544 <para><emphasis>Explanation:</emphasis></para>
546 <para>Spell common words out entirely (do not remove vowels).</para>
548 <para>Use only widely-known domain acronyms and abbreviations.
549 Capitalize all letters of an acronym.</para>
551 <para>Use underscore (_) to separate adjacent acronyms and
552 abbreviations. Never terminate a name with an underscore.</para>
554 <para><emphasis>Example:</emphasis></para>
556 #define USE_IMAGE_LIST 1</programlisting>
558 <para><emphasis>Instead of:</emphasis></para>
562 #define USE_IMG_LST 1 or
563 #define _USE_IMAGE_LIST 1 or
564 #define USE_IMAGE_LIST_ 1 or
565 #define use_image_list 1 or
566 #define UseImageList 1
576 <sect2 id="s15"><title>Using Space</title>
580 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
582 <para><emphasis>Explanation:</emphasis></para>
584 <para>The brace needs to be on a line all by itself, not at the
585 end of the statement. Curly braces should line up with the
586 construct that they're associated with. This practice makes it
587 easier to identify the opening and closing braces for a
590 <para><emphasis>Example:</emphasis></para>
597 <para><emphasis>Instead of:</emphasis></para>
599 <para>if ( this == that ) { ... }</para>
603 <para>if ( this == that ) { ... }</para>
605 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
606 inside a loop, and it is trivial, i.e. it tests for a
607 condidtion that is obvious from the purpose of the block,
608 one-liners as above may optically preserve the loop structure
609 and make it easier to read.</para>
611 <para><emphasis>Status:</emphasis> developer-discrection.</para>
613 <para><emphasis>Example exception:</emphasis></para>
615 while ( more lines are read )
617 /* Please document what is/is not a comment line here */
618 if ( it's a comment ) continue;
620 do_something( line );
626 <sect3 id="s17"><title>ALL control statements should have a
629 <para><emphasis>Explanation:</emphasis></para>
631 <para>Using braces to make a block will make your code more
632 readable and less prone to error. All control statements should
633 have a block defined.</para>
635 <para><emphasis>Example:</emphasis></para>
643 <para><emphasis>Instead of:</emphasis></para>
645 <para>if ( this == that ) DoSomething(); DoSomethingElse();</para>
649 <para>if ( this == that ) DoSomething();</para>
651 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
652 in a manner other than that which the developer desired (per
653 indentation). Using code braces would have prevented this
654 "feature". The "explanation" and "exception" from the point
655 above also applies.</para>
661 <sect3 id="s18"><title>Do not belabor/blow-up boolean
664 <para><emphasis>Example:</emphasis></para>
666 structure->flag = ( condition );</programlisting>
668 <para><emphasis>Instead of:</emphasis></para>
670 <para>if ( condition ) { structure->flag = 1; } else {
671 structure->flag = 0; }</para>
673 <para><emphasis>Note:</emphasis> The former is readable and consice. The later
674 is wordy and inefficient. Please assume that any developer new
675 to the project has at least a "good" knowledge of C/C++. (Hope
676 I do not offend by that last comment ... 8-)</para>
682 <sect3 id="s19"><title>Use white space freely because it is
685 <para><emphasis>Explanation:</emphasis></para>
687 <para>Make it readable. The notable exception to using white space
688 freely is listed in the next guideline.</para>
690 <para><emphasis>Example:</emphasis></para>
694 int anotherValue = 0;
695 int thisVariable = 0;
697 if ( thisVariable == thatVariable )
699 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
704 <sect3 id="s20"><title>Don't use white space around structure
707 <para><emphasis>Explanation:</emphasis></para>
709 <para>- structure pointer operator ( "->" ) - member operator (
710 "." ) - functions and parentheses</para>
712 <para>It is a general coding practice to put pointers, references,
713 and function parentheses next to names. With spaces, the
714 connection between the object and variable/function name is not
717 <para><emphasis>Example:</emphasis></para>
721 FunctionName();</programlisting>
723 <para><emphasis>Instead of:</emphasis> aStruct -> aMember; aStruct . aMember;
724 FunctionName ();</para>
730 <sect3 id="s21"><title>Make the last brace of a function stand
733 <para><emphasis>Example:</emphasis></para>
740 } /* -END- function1 */
745 } /* -END- function2 */
748 <para><emphasis>Instead of:</emphasis></para>
750 <para>int function1( ... ) { ...code... return( retCode ); } int
751 function2( ... ) { }</para>
753 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
754 lines afterwards. This makes the end of function standout to
755 the most casual viewer. Although function comments help
756 seperate functions, this is still a good coding practice. In
757 fact, I follow these rules when using blocks in "for", "while",
758 "do" loops, and long if {} statements too. After all whitespace
761 <para><emphasis>Status:</emphasis> developer-discrection on the number of blank
762 lines. Enforced is the end of function comments.</para>
768 <sect3 id="s22"><title>Use 3 character indentions</title>
770 <para><emphasis>Explanation:</emphasis></para>
772 <para>If some use 8 character TABs and some use 3 character TABs,
773 the code can look *very* ragged. So use 3 character indentions
774 only. If you like to use TABs, pass your code through a filter
775 such as "expand -t3" before checking in your code.</para>
777 <para><emphasis>Example:</emphasis></para>
779 static const char * const url_code_map[256] =
789 return( ALWAYS_TRUE );
793 return( HOW_DID_YOU_GET_HERE );
796 return( NEVER_GETS_HERE );
805 <sect2 id="s23"><title>Initializing</title>
809 <sect3 id="s24"><title>Initialize all variables</title>
811 <para><emphasis>Explanation:</emphasis></para>
813 <para>Do not assume that the variables declared will not be used
814 until after they have been assigned a value somewhere else in
815 the code. Remove the chance of accidentally using an unassigned
818 <para><emphasis>Example:</emphasis></para>
822 struct *ptr = NULL;</programlisting>
824 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
825 message says you are trying to access memory address 00000000
826 and not 129FA012; or arrayPtr[20] causes a SIGSEV vs.
829 <para><emphasis>Status:</emphasis> developer-discrection if and only if the
830 variable is assigned a value "shortly after" declaration.</para>
836 <sect2 id="s25"><title>Functions</title>
840 <sect3 id="s26"><title>Name functions that return a boolean as a
843 <para><emphasis>Explanation:</emphasis></para>
845 <para>Value should be phrased as a question that would logically
846 be answered as a true or false statement</para>
848 <para><emphasis>Example:</emphasis></para>
857 <sect3 id="s27"><title>Always specify a return type for a
860 <para><emphasis>Explanation:</emphasis></para>
862 <para>The default return for a function is an int. To avoid
863 ambiguity, create a return for a function when the return has a
864 purpose, and create a void return type if the function does not
865 need to return anything.</para>
871 <sect3 id="s28"><title>Minimize function calls when iterating by
872 using variables</title>
874 <para><emphasis>Explanation:</emphasis></para>
876 <para>It is easy to write the following code, and a clear argument
877 can be made that the code is easy to understand:</para>
879 <para><emphasis>Example:</emphasis></para>
881 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
886 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
887 each and every iteration. This increases the overhead in the
888 program, because the compiler has to look up the function each
889 time, call it, and return a value. Depending on what occurs in
890 the blockListLength() call, it might even be creating and
891 destroying structures with each iteration, even though in each
892 case it is comparing "cnt" to the same value, over and over.
893 Remember too - even a call to blockListLength() is a function
894 call, with the same overhead.</para>
896 <para>Instead of using a function call during the iterations,
897 assign the value to a variable, and evaluate using the
900 <para><emphasis>Example:</emphasis></para>
902 size_t len = blockListLength();
904 for ( size_t cnt = 0; cnt < len; cnt ++ )
909 <para><emphasis>Exceptions:</emphasis> if the value of blockListLength() *may*
910 change or could *potentially* change, then you must code the
911 function call in the for/while loop.</para>
917 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
919 <para><emphasis>Explanation:</emphasis></para>
921 <para>This allows a developer to define a const pointer and call
922 your function. If your function does not have the const
923 keyword, we may not be able to use your function. Consider
924 strcmp, if it were defined as: extern int strcmp( char *s1,
927 <para>I could then not use it to compare argv's in main: int main(
928 int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
931 <para>Both these pointers are *const*! If the c runtime library
932 maintainers do it, we should too.</para>
938 <sect3 id="s30"><title>Pass and Return by Value</title>
940 <para><emphasis>Explanation:</emphasis></para>
942 <para>Most structures cannot fit onto a normal stack entry (i.e.
943 they are not 4 bytes or less). Aka, a function declaration
944 like: int load_aclfile( struct client_state csp )</para>
946 <para>would not work. So, to be consistent, we should declare all
947 prototypes with "pass by value": int load_aclfile( struct
948 client_state *csp )</para>
954 <sect3 id="s31"><title>Names of include files</title>
956 <para><emphasis>Explanation:</emphasis></para>
958 <para>Your include statements should contain the file name without
959 a path. The path should be listed in the Makefile, using -I as
960 processor directive to search the indicated paths. An exception
961 to this would be for some proprietary software that utilizes a
962 partial path to distinguish their header files from system or
963 other header files.</para>
965 <para><emphasis>Example:</emphasis></para>
967 #include <iostream.h> /* This is not a local include */
968 #include "config.h" /* This IS a local include */
971 <para><emphasis>Exception:</emphasis></para>
975 /* This is not a local include, but requires a path element. */
976 #include <sys/fileName.h>
980 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
981 without a _very_ good reason. This duplicates the #include
982 "file.h" behaviour.</para>
988 <sect3 id="s32"><title>Provide multiple inclusion
991 <para><emphasis>Explanation:</emphasis></para>
993 <para>Prevents compiler and linker errors resulting from
994 redefinition of items.</para>
996 <para>Wrap each header file with the following syntax to prevent
997 multiple inclusions of the file. Of course, replace PROJECT_H
998 with your file name, with "." Changed to "_", and make it
1001 <para><emphasis>Example:</emphasis></para>
1003 #ifndef PROJECT_H_INCLUDED
1004 #define PROJECT_H_INCLUDED
1006 #endif /* ndef PROJECT_H_INCLUDED */
1011 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1013 <para><emphasis>Explanation:</emphasis></para>
1015 <para>If our headers are included from C++, they must declare our
1016 functions as `extern "C"`. This has no cost in C, but increases
1017 the potential re-usability of our code.</para>
1019 <para><emphasis>Example:</emphasis></para>
1024 #endif /* def __cplusplus */
1026 ... function definitions here ...
1030 #endif /* def __cplusplus */
1035 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1036 Declaration Instead of Includes</title>
1038 <para><emphasis>Explanation:</emphasis></para>
1040 <para>Useful in headers that include pointers to other struct's.
1041 Modifications to excess header files may cause needless
1044 <para><emphasis>Example:</emphasis></para>
1046 /*********************************************************************
1047 * We're avoiding an include statement here!
1048 *********************************************************************/
1050 extern file_list *xyz;</programlisting>
1052 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1053 pointer), then including the proper header file is necessary.
1054 If you only want to prototype a pointer, however, the header
1055 file is unneccessary.</para>
1057 <para><emphasis>Status:</emphasis> Use with discrection.</para>
1063 <sect2 id="s35"><title>General Coding Practices</title>
1067 <sect3 id="s36"><title>Turn on warnings</title>
1069 <para><emphasis>Explanation</emphasis></para>
1071 <para>Compiler warnings are meant to help you find bugs. You
1072 should turn on as many as possible. With GCC, the switch is
1073 "-Wall". Try and fix as many warnings as possible.</para>
1079 <sect3 id="s37"><title>Provide a default case for all switch
1082 <para><emphasis>Explanation:</emphasis></para>
1084 <para>What you think is guaranteed is never really guaranteed. The
1085 value that you don't think you need to check is the one that
1086 someday will be passed. So, to protect yourself from the
1087 unknown, always have a default step in a switch statement.</para>
1089 <para><emphasis>Example:</emphasis></para>
1091 switch( hash_string( cmd ) )
1093 case hash_actions_file :
1103 ... anomly code goes here ...
1104 continue; / break; / exit( 1 ); / etc ...
1106 } /* end switch( hash_string( cmd ) ) */</programlisting>
1108 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1109 are obviously exempt from this point. Of note, most of the
1110 WIN32 code calls `DefWindowProc' after the switch statement.
1111 This API call *should* be included in a default statement.</para>
1113 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1114 as a robust programming issue. The "anomly code goes here" may
1115 be no more than a print to the STDERR stream (as in
1116 load_config). Or it may really be an ABEND condition.</para>
1118 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1124 <sect3 id="s38"><title>Try to avoid falling through cases in a
1125 switch statement.</title>
1127 <para><emphasis>Explanation:</emphasis></para>
1129 <para>In general, you will want to have a 'break' statement within
1130 each 'case' of a switch statement. This allows for the code to
1131 be more readable and understandable, and furthermore can
1132 prevent unwanted surprises if someone else later gets creative
1133 and moves the code around.</para>
1135 <para>The language allows you to plan the fall through from one
1136 case statement to another simply by omitting the break
1137 statement within the case statement. This feature does have
1138 benefits, but should only be used in rare cases. In general,
1139 use a break statement for each case statement.</para>
1141 <para>If you choose to allow fall through, you should comment both
1142 the fact of the fall through and reason why you felt it was
1149 <sect3 id="s39"><title>Use 'long' or 'short' Instead of
1152 <para><emphasis>Explanation:</emphasis></para>
1154 <para>On 32-bit platforms, int usually has the range of long. On
1155 16-bit platforms, int has the range of short.</para>
1157 <para><emphasis>Status:</emphasis> open-to-debate. In the case of most FSF
1158 projects (including X/GNU-Emacs), there are typedefs to int4,
1159 int8, int16, (or equivalence ... I forget the exact typedefs
1160 now). Should we add these to IJB now that we have a "configure"
1167 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1169 <para><emphasis>Explanation:</emphasis></para>
1171 <para>The type of size_t varies across platforms. Do not make
1172 assumptions about whether it is signed or unsigned, or about
1173 how long it is. Do not compare a size_t against another
1174 variable of a different type (or even against a constant)
1175 without casting one of the values. Try to avoid using size_t if
1182 <sect3 id="s41"><title>Declare each variable and struct on its
1185 <para><emphasis>Explanation:</emphasis></para>
1187 <para>It can be tempting to declare a series of variables all on
1188 one line. Don't.</para>
1190 <para><emphasis>Example:</emphasis></para>
1194 long c = 0;</programlisting>
1196 <para><emphasis>Instead of:</emphasis></para>
1198 <para>long a, b, c;</para>
1200 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1201 individual variables - easier to add new variables without
1202 messing up the original ones - when searching on a variable to
1203 find its type, there is less clutter to "visually"
1206 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1207 variables or other trivial variables; feel free to declare them
1208 on 1 line. You should, although, provide a good comment on
1209 their functions.</para>
1211 <para><emphasis>Status:</emphasis> developer-discrection.</para>
1217 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1219 <para><emphasis>Explanation:</emphasis></para>
1221 <para>Create a local stuct (on the stack) if the variable will
1222 live and die within the context of one function call.</para>
1224 <para>Only "malloc" a struct (on the heap) if the variable's life
1225 will extend beyond the context of one function call.</para>
1227 <para><emphasis>Example:</emphasis></para>
1229 If a function creates a struct and stores a pointer to it in a
1230 list, then it should definately be allocated via `malloc'.
1235 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1236 Responsible for Ensuring 'free'</title>
1238 <para><emphasis>Explanation:</emphasis></para>
1240 <para>If you have to "malloc" an instance, you are responsible for
1241 insuring that the instance is `free'd, even if the deallocation
1242 event falls within some other programmer's code. You are also
1243 responsible for ensuring that deletion is timely (i.e. not too
1244 soon, not too late). This is known as "low-coupling" and is a
1245 "good thing (tm)". You may need to offer a
1246 free/unload/destuctor type function to accomodate this.</para>
1248 <para><emphasis>Example:</emphasis></para>
1250 int load_re_filterfile( struct client_state *csp ) { ... }
1251 static void unload_re_filterfile( void *f ) { ... }</programlisting>
1253 <para><emphasis>Exceptions:</emphasis></para>
1255 <para>The developer cannot be expected to provide `free'ing
1256 functions for C run-time library functions ... such as
1259 <para><emphasis>Status:</emphasis> developer-discrection. The "main" use of this
1260 standard is for allocating and freeing data structures (complex
1267 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1268 and in order</title>
1270 <para><emphasis>Explanation:</emphasis></para>
1272 <para>I have ordered all of the "blocker" file code to be in alpha
1273 order. It is easier to add/read new blockers when you expect a
1274 certain order.</para>
1276 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1277 places by POPUP tests coming before PCRS tests. But since
1278 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1279 it should come first.</para>
1285 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1286 exitinst code, use FIXME</title>
1288 <para><emphasis>Explanation:</emphasis></para>
1290 <para>If you have enough confidence in new code or confidence in
1291 your changes, but are not *quite* sure of the reprocussions,
1294 <para>/* FIXME: this code has a logic error on platform XYZ, *
1295 attempthing to fix */ #ifdef PLATFORM ...changed code here...
1300 <para>/* FIXME: I think the original author really meant this...
1301 */ ...changed code here...</para>
1305 <para>/* FIXME: new code that *may* break something else... */
1306 ...new code here...</para>
1308 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1309 be a "good thing (tm)", it will be easier to identify and
1310 include in the project (or conversly exclude from the
1318 <sect2 id="s46"><title>Addendum: Template for files and function
1319 comment blocks:</title>
1321 <para><emphasis>Example for file comments:</emphasis></para>
1323 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.20 2002/04/04 03:28:27 david__schmidt Exp $";
1324 /*********************************************************************
1326 * File : $S<!-- Break CVS Substitution -->ource$
1328 * Purpose : (Fill me in with a good description!)
1330 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1331 * Privoxy team. http://www.privoxy.org/
1333 * Based on the Internet Junkbuster originally written
1334 * by and Copyright (C) 1997 Anonymous Coders and
1335 * Junkbusters Corporation. http://www.junkbusters.com
1337 * This program is free software; you can redistribute it
1338 * and/or modify it under the terms of the GNU General
1339 * Public License as published by the Free Software
1340 * Foundation; either version 2 of the License, or (at
1341 * your option) any later version.
1343 * This program is distributed in the hope that it will
1344 * be useful, but WITHOUT ANY WARRANTY; without even the
1345 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1346 * PARTICULAR PURPOSE. See the GNU General Public
1347 * License for more details.
1349 * The GNU General Public License should be included with
1350 * this file. If not, you can view it at
1351 * http://www.gnu.org/copyleft/gpl.html
1352 * or write to the Free Software Foundation, Inc., 59
1353 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1356 * $L<!-- Break CVS Substitution -->og$
1358 *********************************************************************/
1363 ...necessary include files for us to do our work...
1365 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1368 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1369 added to the "show-proxy-args" page. If this is a brand new
1370 creation by you, you are free to change the "Copyright" section
1371 to represent the rights you wish to maintain.</para>
1373 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1374 after the comment flower box is handy for (X|GNU)Emacs users to
1375 skip the verbige and get to the heart of the code (via
1376 `forward-page' and `backward-page'). Please include it if you
1379 <para><emphasis>Example for file header comments:</emphasis></para>
1383 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.20 2002/04/04 03:28:27 david__schmidt Exp $"
1384 /*********************************************************************
1386 * File : $S<!-- Break CVS Substitution -->ource$
1388 * Purpose : (Fill me in with a good description!)
1390 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1391 * Privoxy team. http://www.privoxy.org/
1393 * Based on the Internet Junkbuster originally written
1394 * by and Copyright (C) 1997 Anonymous Coders and
1395 * Junkbusters Corporation. http://www.junkbusters.com
1397 * This program is free software; you can redistribute it
1398 * and/or modify it under the terms of the GNU General
1399 * Public License as published by the Free Software
1400 * Foundation; either version 2 of the License, or (at
1401 * your option) any later version.
1403 * This program is distributed in the hope that it will
1404 * be useful, but WITHOUT ANY WARRANTY; without even the
1405 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1406 * PARTICULAR PURPOSE. See the GNU General Public
1407 * License for more details.
1409 * The GNU General Public License should be included with
1410 * this file. If not, you can view it at
1411 * http://www.gnu.org/copyleft/gpl.html
1412 * or write to the Free Software Foundation, Inc., 59
1413 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1416 * $L<!-- Break CVS Substitution -->og$
1418 *********************************************************************/
1421 #include "project.h"
1427 ... function headers here ...
1430 /* Revision control strings from this header and associated .c file */
1431 extern const char FILENAME_rcs[];
1432 extern const char FILENAME_h_rcs[];
1439 #endif /* ndef _FILENAME_H */
1448 <para><emphasis>Example for function comments:</emphasis></para>
1450 /*********************************************************************
1452 * Function : FUNCTION_NAME
1454 * Description : (Fill me in with a good description!)
1457 * 1 : param1 = pointer to an important thing
1458 * 2 : x = pointer to something else
1460 * Returns : 0 => Ok, everything else is an error.
1462 *********************************************************************/
1463 int FUNCTION_NAME( void *param1, const char *x )
1471 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1472 able to parse our code to create a "self-documenting" web
1479 <!-- ~~~~~ New section ~~~~~ -->
1480 <sect1 id="cvs"><title>Version Control Guidelines</title>
1481 <para>To be filled. note on cvs comments. Don't only comment what you did,
1482 but also why you did it!
1486 <!-- ~~~~~ New section ~~~~~ -->
1487 <sect1 id="testing"><title>Testing Guidelines</title>
1491 <!-- ~~~~~ New section ~~~~~ -->
1492 <sect2 id="testing-plan"><title>Testplan for releases</title>
1494 Explain release numbers. major, minor. developer releases. etc.
1496 <orderedlist numeration="arabic">
1498 Remove any existing rpm with rpm -e
1501 Remove any file that was left over. This includes (but is not limited to)
1503 <listitem><para>/var/log/privoxy</para></listitem>
1504 <listitem><para>/etc/privoxy</para></listitem>
1505 <listitem><para>/usr/sbin/privoxy</para></listitem>
1506 <listitem><para>/etc/init.d/privoxy</para></listitem>
1507 <listitem><para>/usr/doc/privoxy*</para></listitem>
1511 Install the rpm. Any error messages?
1513 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1514 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1515 autostart work?</para></listitem>
1516 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1517 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1522 <!-- ~~~~~ New section ~~~~~ -->
1523 <sect2 id="testing-report"><title>Test reports</title>
1525 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
1526 at sourceforge. Three simple steps:
1529 <listitem><para>Select category: the distribution you test on.</para></listitem>
1530 <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
1531 <listitem><para>Fill the Summary and Detailed Description with something
1532 intelligent (keep it short and precise).</para>
1535 Do not mail to the mailinglist (we cannot keep track on issues there).
1541 <!-- ~~~~~ New section ~~~~~ -->
1542 <sect1 id="newrelease"><title>Releasing a new version</title>
1544 To minimize trouble with distribution contents, webpage
1545 errors and the like, we strongly encourage you
1546 to follow this section if you prepare a new release of
1547 code or new pages on the webserver.
1550 The following programs are required to follow this process:
1551 <filename>ncftpput</filename> (ncftp), <filename>scp</filename> (ssh),
1552 <filename>gmake</filename> (GNU's version of make), autoconf, cvs, ???.
1555 <sect2 id="beforerelease">
1556 <title>Before the Release</title>
1558 The following <emphasis>must be done by one of the
1559 developers</emphasis> prior to each new release:
1565 Make sure that everybody who has worked on the code in the last
1566 couple of days has had a chance to yell <quote>no!</quote> in case
1567 they have pending changes/fixes in their pipelines.
1572 Increment the version number in <filename>configure.in</filename> in
1573 CVS. Also, the RPM release number in
1574 <filename>configure.in</filename>. Do NOT touch version information
1575 after export from CVS. <emphasis>All packages</emphasis> will use the
1576 version and release data from <filename>configure.in</filename>.
1577 Local files should not be changed, except prior to a CVS commit!!!
1578 This way we are all on the same page!
1583 If the default actionsfile has changed since last release,
1584 bump up its version info in this line:
1588 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
1592 Then change the version info in doc/webserver/actions/index.php,
1593 line: '$required_actions_file_version = "A.B";'
1598 Tag all files in CVS with the version number with
1599 <quote><command>cvs tag v_X_Y_Z</command></quote> (where X = major, Y
1600 = minor, Z = point). Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work)
1606 The first package uploaded should be the official
1607 <quote>tarball</quote> release. This is built with the
1608 <quote><command>make tarball-dist</command></quote> Makefile
1609 target, and then can be uploaded with
1610 <quote><command>make tarball-upload</command></quote> (see below).
1617 <sect2 id="newrelease-web"><title>Update the webserver</title>
1619 All files must be group-readable and group-writable (or no one else
1620 will be able to change them). To update the webserver, create any
1621 pages locally in the <filename>doc/webserver</filename> directory (or
1622 create new directories under <filename>doc/webserver</filename>), then do
1630 Note that <quote><command>make dok</command></quote>
1631 (or <quote><command>make redhat-dok</command></quote>) creates
1632 <filename>doc/webserver/user-manual</filename>,
1633 <filename>doc/webserver/developer-manual</filename>,
1634 <filename>doc/webserver/faq</filename> and
1635 <filename>doc/webserver/man-page</filename> automatically.
1638 Please do NOT use any other means of transferring files to the
1639 webserver. <quote><command>make webserver</command></quote> not only
1640 uploads, but will make sure that the appropriate permissions are
1641 preserved for shared group access.
1645 <sect2 id="newrelease-rpm"><title>SuSE or Red Hat</title>
1647 Ensure that you have the latest code version. Hence run:
1652 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1653 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1661 autoheader && autoconf && ./configure
1669 make suse-dist or make redhat-dist
1673 To upload the package to Sourceforge, simply issue
1677 make suse-upload or make redhat-upload
1681 Go to the displayed URL and release the file publicly on Sourceforge.
1685 <sect2 id="newrelease-os2"><title>OS/2</title>
1687 Ensure that you have the latest code version. Hence run:
1692 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1693 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1695 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
1699 You will need a mix of development tools.
1700 The main compilation takes place with IBM Visual Age C++.
1701 Some ancillary work takes place with GNU tools, available from
1702 various sources like hobbes.nmsu.edu.
1703 Specificially, you will need <filename>autoheader</filename>,
1704 <filename>autoconf</filename> and <filename>sh</filename> tools.
1705 The packaging takes place with WarpIN, available from various sources, including
1706 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
1709 Change directory to the <filename>os2setup</filename> directory.
1710 Edit the os2build.cmd file to set the final executable filename.
1713 installExeName='privoxyos2_setup_X.Y.Z.exe'
1715 Next, edit the <filename>IJB.wis</filename> file so the release number matches
1716 in the <filename>PACKAGEID</filename> section:
1718 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
1720 You're now ready to build. Run:
1724 And in the <filename>./files</filename> directory you will have the
1725 WarpIN-installable executable.
1726 Upload this anonymously to
1727 <filename>uploads.sourceforge.net/incoming</filename>, create a release
1728 for it, and you're done.
1732 <sect2 id="newrelease-solaris"><title>Solaris</title>
1734 Login to Sourceforge's compilefarm via ssh
1738 ssh cf.sourceforge.net
1742 Choose the right operating system (not the Debian one). If you have
1743 downloaded <application>Privoxy</application> before,
1748 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1749 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1753 If not, please <ulink
1754 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
1755 Privoxy via CVS first</ulink>. Run:
1759 autoheader && autoconf && ./configure
1771 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
1772 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
1773 to manually upload the archive to Sourceforge's ftp server and release
1778 <sect2 id="newrelease-windows"><title>Windows</title>
1780 Ensure that you have the latest code version. Hence run
1785 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1786 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1794 autoheader && autoconf && ./configure
1802 <sect2 id="newrelease-debian"><title>Debian</title>
1804 Ensure that you have the latest code version. Hence run:
1809 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1810 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1818 autoheader && autoconf && ./configure
1826 <sect2 id="newrelease-macosx"><title>Mac OSX</title>
1828 Ensure that you have the latest code version. Hence run:
1833 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1834 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1836 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
1840 From the osxsetup directory, run:
1846 This will run <filename>autoheader</filename>, <filename>autoconf</filename> and
1847 <filename>configure</filename> as well as <filename>make</filename>.
1848 Finally, it will copy over the necessary files to the ./osxsetup/files directory
1849 for further processing by <filename>PackageMaker</filename>.
1852 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
1853 name to match the release, and hit the "Create package" button.
1854 If you specify ./Privoxy.pkg as the output package name, you can then create
1855 the distributable zip file with the command:
1857 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
1859 You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to
1860 <filename>uploads.sourceforge.net/incoming</filename>,
1861 create a release for it, and you're done.
1865 <sect2 id="newrelease-freebsd"><title>FreeBSD</title>
1867 Change the version number of <application>Privoxy</application> in the
1868 configure.in file. Run:
1870 autoheader && autoconf && ./configure
1875 Login to Sourceforge's compilefarm via ssh:
1879 ssh cf.sourceforge.net
1883 Choose the right operating system. If you have downloaded Privoxy
1889 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1890 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1894 If not, please <ulink
1895 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
1896 Privoxy via CVS first</ulink>. Run:
1900 autoheader && autoconf && ./configure
1912 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
1913 freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
1914 to manually upload the archive to Sourceforge's ftp server and release
1919 <sect2 id="newrelease-tarball"><title>Tarball</title>
1921 Ensure that you have the latest code version. Hence run:
1926 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1927 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1936 autoheader && autoconf && ./configure
1948 To upload the package to Sourceforge, simply issue
1956 Goto the displayed URL and release the file publicly on Sourceforge.
1960 <sect2 id="newrelease-hpux"><title>HP-UX 11</title>
1962 Ensure that you have the latest code version. Hence run:
1967 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1968 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1976 autoheader && autoconf && ./configure
1984 <sect2 id="newrelease-amiga"><title>Amiga OS</title>
1986 Ensure that you have the latest code version. Hence run:
1991 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1992 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2000 autoheader && autoconf && ./configure
2008 <sect2 id="newrelease-aix"><title>AIX</title>
2010 Login to Sourceforge's compilefarm via ssh:
2014 ssh cf.sourceforge.net
2018 Choose the right operating system. If you have downloaded Privoxy
2024 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2025 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2029 If not, please <ulink
2030 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
2031 Privoxy via CVS first</ulink>. Run:
2035 autoheader && autoconf && ./configure
2047 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2048 aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
2049 to manually upload the archive to Sourceforge's ftp server and release
2056 <!-- ~~~~~ New section ~~~~~ -->
2057 <sect1 id="contact"><title>Contact the developers</title>
2059 Please see the contact page in the <ulink
2060 url="../user-manual/contact.html">user-manual</ulink> for details.
2064 <!-- ~~~~~ New section ~~~~~ -->
2065 <sect1 id="copyright"><title>Copyright and History</title>
2067 Please see the <ulink
2068 url="../user-manual/copyright.html#HISTORY">user-manual</ulink> for
2069 information on Copyright and History.
2073 <!-- ~~~~~ New section ~~~~~ -->
2074 <sect1 id="seealso"><title>See also</title>
2076 Please see the <ulink
2077 url="../user-manual/seealso.html">user-manual</ulink> for others
2084 This program is free software; you can redistribute it
2085 and/or modify it under the terms of the GNU General
2086 Public License as published by the Free Software
2087 Foundation; either version 2 of the License, or (at
2088 your option) any later version.
2090 This program is distributed in the hope that it will
2091 be useful, but WITHOUT ANY WARRANTY; without even the
2092 implied warranty of MERCHANTABILITY or FITNESS FOR A
2093 PARTICULAR PURPOSE. See the GNU General Public
2094 License for more details.
2096 The GNU General Public License should be included with
2097 this file. If not, you can view it at
2098 http://www.gnu.org/copyleft/gpl.html
2099 or write to the Free Software Foundation, Inc., 59
2100 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2102 $Log: developer-manual.sgml,v $
2103 Revision 1.20 2002/04/04 03:28:27 david__schmidt
2106 Revision 1.19 2002/04/03 15:09:42 david__schmidt
2107 Add OS/2 build section
2109 Revision 1.18 2002/04/03 03:51:48 hal9
2112 Revision 1.17 2002/04/03 01:21:17 hal9
2113 Implementing Andreas's suggestions for Release sections.
2115 Revision 1.16 2002/03/31 23:04:40 hal9
2116 Fleshed out the doc section, and added something for an intro so it was not
2119 Revision 1.15 2002/03/30 22:29:47 swa
2122 Revision 1.14 2002/03/30 19:04:08 swa
2123 people release differently. no good.
2124 I want to make parts of the docs only.
2126 Revision 1.13 2002/03/27 01:16:41 hal9
2129 Revision 1.12 2002/03/27 01:02:51 hal9
2130 Touch up on name change...
2132 Revision 1.11 2002/03/26 22:29:55 swa
2133 we have a new homepage!
2135 Revision 1.10 2002/03/24 12:33:01 swa
2138 Revision 1.9 2002/03/24 11:01:05 swa
2141 Revision 1.8 2002/03/23 15:13:11 swa
2142 renamed every reference to the old name with foobar.
2143 fixed "application foobar application" tag, fixed
2144 "the foobar" with "foobar". left junkbustser in cvs
2145 comments and remarks to history untouched.
2147 Revision 1.7 2002/03/11 13:13:27 swa
2148 correct feedback channels
2150 Revision 1.6 2002/02/24 14:25:06 jongfoster
2151 Formatting changes. Now changing the doctype to DocBook XML 4.1
2152 will work - no other changes are needed.
2154 Revision 1.5 2001/10/31 18:16:51 swa
2155 documentation added: howto generate docs in text and html
2156 format, howto move stuff to the webserver.
2158 Revision 1.4 2001/09/23 10:13:48 swa
2159 upload process established. run make webserver and
2160 the documentation is moved to the webserver. documents
2161 are now linked correctly.
2163 Revision 1.3 2001/09/13 15:27:40 swa
2166 Revision 1.2 2001/09/13 15:20:17 swa
2167 merged standards into developer manual
2169 Revision 1.1 2001/09/12 15:36:41 swa
2170 source files for junkbuster documentation
2172 Revision 1.3 2001/09/10 17:43:59 swa
2173 first proposal of a structure.
2175 Revision 1.2 2001/06/13 14:28:31 swa
2176 docs should have an author.
2178 Revision 1.1 2001/06/13 14:20:37 swa
2179 first import of project's documentation for the webserver.