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">
8 File : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
10 Purpose : developer manual
11 This file belongs into
12 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
14 $Id: developer-manual.sgml,v 1.17 2002/04/03 01:21:17 hal9 Exp $
16 Written by and Copyright (C) 2001 the SourceForge
17 Privoxy team. http://www.privoxy.org/
19 Based on the Internet Junkbuster originally written
20 by and Copyright (C) 1997 Anonymous Coders and
21 Junkbusters Corporation. http://www.junkbusters.com
26 <title>Privoxy Developer Manual</title>
28 <pubdate>$Id: developer-manual.sgml,v 1.17 2002/04/03 01:21:17 hal9 Exp $</pubdate>
33 <orgname>By: Privoxy Developers</orgname>
42 This is here to keep vim syntax file from breaking :/
43 If I knew enough to fix it, I would.
44 PLEASE DO NOT REMOVE! HB: hal@foobox.net
49 The developer manual gives the users information on how to help the developer
50 team. It provides guidance on coding, testing, documentation and other
59 You can find the latest version of the this manual at <ulink
60 url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
61 Please see the Contact section of the <ulink
62 url="../user-manual/contact.html">User Manual</ulink> on how to contact the
67 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
73 <!-- ~~~~~ New section ~~~~~ -->
74 <sect1 id="introduction"><title>Introduction</title>
77 I don't like seeing blank space :) So added *something* here.
81 <application>Privoxy</application>, as an heir to
82 <application>Junkbuster</application>, is an Open Source project
83 and licensed under the GPL. As such, <application>Privoxy</application>
84 development is potentially open to anyone who has the time, knowledge,
85 and desire to contribute in any capacity. Our goals are simply to
86 continue the mission, to improve <application>Privoxy</application>, and
87 to make it available to as wide an audience as possible.
90 One does not have to be a programmer to contribute. Packaging, testing,
91 and porting, are all important jobs as well.
95 <!-- ~~~~~ New section ~~~~~ -->
96 <sect1 id="quickstart"><title>Quickstart to Privoxy Development</title>
98 You'll need an account on <ulink
99 url="http://sourceforge.net">Sourceforge</ulink> to support our development.
100 Mail your ID to the list and wait until a project manager has added you.
104 For the time being (read, this section is under construction), please note the
105 following guidelines for changing stuff in the code. If it is
106 <orderedlist numeration="arabic">
108 A bugfix / clean-up / cosmetic thing: shoot
111 A new feature that can be turned off: shoot
114 A clear improvement w/o side effects on other parts of the code: shoot
117 A matter of taste: ask the list
120 A major redesign of some part of the code: ask the list
126 <!-- ~~~~~ New section ~~~~~ -->
127 <sect1 id="documentation"><title>Documentation Guidelines</title>
129 All formal documents are maintained in docbook SGML and located
130 in the <computeroutput>doc/source</computeroutput> directory. You will
131 need <ulink url="http://www.docbook.org">docbook</ulink> and the
132 docbook stylesheets (or comparable alternatives), and either
133 <application>jade</application> or <application>openjade</application>
134 installed in order to build docs from source. Currently there is
136 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
138 url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>,
139 and, of course this, the <citetitle>developer-manual</citetitle> in
143 Other, less formal documents (e.g. README, LICENSE) are
144 maintained as plain text files in the toplevel source
148 Packagers are encouraged to include this documentation. For those
149 without the ability to build the docs locally, text versions of
150 each are kept in CVS. Or HTML versions can be downloaded from the <ulink
151 url="http://www.privoxy.org">www.privoxy.org</ulink> website, which
152 should be fairly current.
155 Formal documents are built with the Makefile targets of
156 <computeroutput>make dok</computeroutput>, or alternately
157 <computeroutput>make redhat-dok</computeroutput>. If you
158 have problems, try both. The build process uses the document
159 SGML sources in <computeroutput>doc/source</computeroutput> to
160 update all text files in <computeroutput>doc/text</computeroutput>
161 and to update all HTML documents in
162 <computeroutput>doc/webserver</computeroutput>.
165 Documentation writers should please make sure documents build
166 successfully before committing to CVS.
169 How do you update the webserver (i.e. the pages on privoxy.org)?
170 <orderedlist numeration="arabic">
172 First, build the docs by running <computeroutput>make
173 dok</computeroutput> (or alternately <computeroutput>make
174 redhat-dok</computeroutput>).
177 Run <computeroutput>make webserver</computeroutput> which copies all files from
178 <computeroutput>doc/webserver</computeroutput> to the sourceforge webserver
185 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
186 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
188 <!-- ~~~~~ New section ~~~~~ -->
189 <sect1 id="coding"><title>Coding Guidelines</title>
191 <sect2 id="s1"><title>Introduction</title>
193 <para>This set of standards is designed to make our lives easier. It is
194 developed with the simple goal of helping us keep the "new and improved
195 <application>Privoxy</application>" consistent and reliable. Thus making
196 maintenance easier and increasing chances of success of the
199 <para>And that of course comes back to us as individuals. If we can
200 increase our development and product efficiencies then we can solve more
201 of the request for changes/improvements and in general feel good about
202 ourselves. ;-></para>
206 <sect2 id="s2"><title>Using Comments</title>
209 <sect3 id="s3"><title>Comment, Comment, Comment</title>
211 <para><emphasis>Explanation:</emphasis></para>
213 <para>Comment as much as possible without commenting the obvious.
214 For example do not comment "aVariable is equal to bVariable".
215 Instead explain why aVariable should be equal to the bVariable.
216 Just because a person can read code does not mean they will
217 understand why or what is being done. A reader may spend a lot
218 more time figuring out what is going on when a simple comment
219 or explanation would have prevented the extra research. Please
220 help your brother IJB'ers out!</para>
222 <para>The comments will also help justify the intent of the code.
223 If the comment describes something different than what the code
224 is doing then maybe a programming error is occurring.</para>
226 <para><emphasis>Example:</emphasis></para>
228 /* if page size greater than 1k ... */
229 if ( PageLength() > 1024 )
231 ... "block" the page up ...
234 /* if page size is small, send it in blocks */
235 if ( PageLength() > 1024 )
237 ... "block" the page up ...
240 This demonstrates 2 cases of "what not to do". The first is a
241 "syntax comment". The second is a comment that does not fit what
242 is actually being done.
248 <sect3 id="s4"><title>Use blocks for comments</title>
250 <para><emphasis>Explanation:</emphasis></para>
252 <para>Comments can help or they can clutter. They help when they
253 are differentiated from the code they describe. One line
254 comments do not offer effective separation between the comment
255 and the code. Block identifiers do, by surrounding the code
256 with a clear, definable pattern.</para>
258 <para><emphasis>Example:</emphasis></para>
260 /*********************************************************************
261 * This will stand out clearly in your code!
262 *********************************************************************/
263 if ( thisVariable == thatVariable )
265 DoSomethingVeryImportant();
269 /* unfortunately, this may not */
270 if ( thisVariable == thatVariable )
272 DoSomethingVeryImportant();
276 if ( thisVariable == thatVariable ) /* this may not either */
278 DoSomethingVeryImportant();
281 <para><emphasis>Exception:</emphasis></para>
283 <para>If you are trying to add a small logic comment and do not
284 wish to "disrubt" the flow of the code, feel free to use a 1
285 line comment which is NOT on the same line as the code.</para>
291 <sect3 id="s5"><title>Keep Comments on their own line</title>
293 <para><emphasis>Explanation:</emphasis></para>
295 <para>It goes back to the question of readability. If the comment
296 is on the same line as the code it will be harder to read than
297 the comment that is on its own line.</para>
299 <para>There are three exceptions to this rule, which should be
300 violated freely and often: during the definition of variables,
301 at the end of closing braces, when used to comment
304 <para><emphasis>Example:</emphasis></para>
306 /*********************************************************************
307 * This will stand out clearly in your code,
308 * But the second example won't.
309 *********************************************************************/
310 if ( thisVariable == thatVariable )
312 DoSomethingVeryImportant();
315 if ( thisVariable == thatVariable ) /*can you see me?*/
317 DoSomethingVeryImportant(); /*not easily*/
321 /*********************************************************************
322 * But, the encouraged exceptions:
323 *********************************************************************/
324 int urls_read = 0; /* # of urls read + rejected */
325 int urls_rejected = 0; /* # of urls rejected */
329 DoSomethingVeryImportant();
333 short DoSomethingVeryImportant(
334 short firstparam, /* represents something */
335 short nextparam /* represents something else */ )
339 } /* -END- DoSomethingVeryImportant */
344 <sect3 id="s6"><title>Comment each logical step</title>
346 <para><emphasis>Explanation:</emphasis></para>
348 <para>Logical steps should be commented to help others follow the
349 intent of the written code and comments will make the code more
352 <para>If you have 25 lines of code without a comment, you should
353 probably go back into it to see where you forgot to put
356 <para>Most "for", "while", "do", etc... loops _probably_ need a
357 comment. After all, these are usually major logic
364 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
366 <para><emphasis>Explanation:</emphasis></para>
368 <para>A reader of the code should be able to look at the comments
369 just prior to the beginning of a function and discern the
370 reason for its existence and the consequences of using it. The
371 reader should not have to read through the code to determine if
372 a given function is safe for a desired use. The proper
373 information thoroughly presented at the introduction of a
374 function not only saves time for subsequent maintenance or
375 debugging, it more importantly aids in code reuse by allowing a
376 user to determine the safety and applicability of any function
377 for the problem at hand. As a result of such benefits, all
378 functions should contain the information presented in the
379 addendum section of this document.</para>
385 <sect3 id="s8"><title>Comment at the end of braces if the
386 content is more than one screen length</title>
388 <para><emphasis>Explanation:</emphasis></para>
390 <para>Each closing brace should be followed on the same line by a
391 comment that describes the origination of the brace if the
392 original brace is off of the screen, or otherwise far away from
393 the closing brace. This will simplify the debugging,
394 maintenance, and readability of the code.</para>
396 <para>As a suggestion , use the following flags to make the
397 comment and its brace more readable:</para>
399 <para>use following a closing brace: } /* -END- if() or while ()
402 <para><emphasis>Example:</emphasis></para>
406 DoSomethingVeryImportant();
407 ...some long list of commands...
408 } /* -END- if x is 1 */
414 DoSomethingVeryImportant();
415 ...some long list of commands...
416 } /* -END- if ( 1 == X ) */
422 <sect2 id="s9"><title>Naming Conventions</title>
426 <sect3 id="s10"><title>Variable Names</title>
428 <para><emphasis>Explanation:</emphasis></para>
430 <para>Use all lowercase, and seperate words via an underscore
431 ('_'). Do not start an identifier with an underscore. (ANSI C
432 reserves these for use by the compiler and system headers.) Do
433 not use identifiers which are reserved in ANSI C++. (E.g.
434 template, class, true, false, ...). This is in case we ever
435 decide to port Privoxy to C++.</para>
437 <para><emphasis>Example:</emphasis></para>
439 int ms_iis5_hack = 0;</programlisting>
441 <para><emphasis>Instead of:</emphasis></para>
445 int msiis5hack = 0; int msIis5Hack = 0;
453 <sect3 id="s11"><title>Function Names</title>
455 <para><emphasis>Explanation:</emphasis></para>
457 <para>Use all lowercase, and seperate words via an underscore
458 ('_'). Do not start an identifier with an underscore. (ANSI C
459 reserves these for use by the compiler and system headers.) Do
460 not use identifiers which are reserved in ANSI C++. (E.g.
461 template, class, true, false, ...). This is in case we ever
462 decide to port Privoxy to C++.</para>
464 <para><emphasis>Example:</emphasis></para>
466 int load_some_file( struct client_state *csp )</programlisting>
468 <para><emphasis>Instead of:</emphasis></para>
472 int loadsomefile( struct client_state *csp )
473 int loadSomeFile( struct client_state *csp )
481 <sect3 id="s12"><title>Header file prototypes</title>
483 <para><emphasis>Explanation:</emphasis></para>
485 <para>Use a descriptive parameter name in the function prototype
486 in header files. Use the same parameter name in the header file
487 that you use in the c file.</para>
489 <para><emphasis>Example:</emphasis></para>
491 (.h) extern int load_aclfile( struct client_state *csp );
492 (.c) int load_aclfile( struct client_state *csp )</programlisting>
494 <para><emphasis>Instead of:</emphasis>
496 (.h) extern int load_aclfile( struct client_state * ); or
497 (.h) extern int load_aclfile();
498 (.c) int load_aclfile( struct client_state *csp )
506 <sect3 id="s13"><title>Enumerations, and #defines</title>
508 <para><emphasis>Explanation:</emphasis></para>
510 <para>Use all capital letters, with underscores between words. Do
511 not start an identifier with an underscore. (ANSI C reserves
512 these for use by the compiler and system headers.)</para>
514 <para><emphasis>Example:</emphasis></para>
516 (enumeration) : enum Boolean { FALSE, TRUE };
517 (#define) : #define DEFAULT_SIZE 100;</programlisting>
519 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
520 that toggle a feature in the preprocessor: FEATURE_>, where
521 > is a short (preferably 1 or 2 word) description.</para>
523 <para><emphasis>Example:</emphasis></para>
525 #define FEATURE_FORCE 1
528 #define FORCE_PREFIX blah
529 #endif /* def FEATURE_FORCE */
534 <sect3 id="s14"><title>Constants</title>
536 <para><emphasis>Explanation:</emphasis></para>
538 <para>Spell common words out entirely (do not remove vowels).</para>
540 <para>Use only widely-known domain acronyms and abbreviations.
541 Capitalize all letters of an acronym.</para>
543 <para>Use underscore (_) to separate adjacent acronyms and
544 abbreviations. Never terminate a name with an underscore.</para>
546 <para><emphasis>Example:</emphasis></para>
548 #define USE_IMAGE_LIST 1</programlisting>
550 <para><emphasis>Instead of:</emphasis></para>
554 #define USE_IMG_LST 1 or
555 #define _USE_IMAGE_LIST 1 or
556 #define USE_IMAGE_LIST_ 1 or
557 #define use_image_list 1 or
558 #define UseImageList 1
568 <sect2 id="s15"><title>Using Space</title>
572 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
574 <para><emphasis>Explanation:</emphasis></para>
576 <para>The brace needs to be on a line all by itself, not at the
577 end of the statement. Curly braces should line up with the
578 construct that they're associated with. This practice makes it
579 easier to identify the opening and closing braces for a
582 <para><emphasis>Example:</emphasis></para>
589 <para><emphasis>Instead of:</emphasis></para>
591 <para>if ( this == that ) { ... }</para>
595 <para>if ( this == that ) { ... }</para>
597 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
598 inside a loop, and it is trivial, i.e. it tests for a
599 condidtion that is obvious from the purpose of the block,
600 one-liners as above may optically preserve the loop structure
601 and make it easier to read.</para>
603 <para><emphasis>Status:</emphasis> developer-discrection.</para>
605 <para><emphasis>Example exception:</emphasis></para>
607 while ( more lines are read )
609 /* Please document what is/is not a comment line here */
610 if ( it's a comment ) continue;
612 do_something( line );
618 <sect3 id="s17"><title>ALL control statements should have a
621 <para><emphasis>Explanation:</emphasis></para>
623 <para>Using braces to make a block will make your code more
624 readable and less prone to error. All control statements should
625 have a block defined.</para>
627 <para><emphasis>Example:</emphasis></para>
635 <para><emphasis>Instead of:</emphasis></para>
637 <para>if ( this == that ) DoSomething(); DoSomethingElse();</para>
641 <para>if ( this == that ) DoSomething();</para>
643 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
644 in a manner other than that which the developer desired (per
645 indentation). Using code braces would have prevented this
646 "feature". The "explanation" and "exception" from the point
647 above also applies.</para>
653 <sect3 id="s18"><title>Do not belabor/blow-up boolean
656 <para><emphasis>Example:</emphasis></para>
658 structure->flag = ( condition );</programlisting>
660 <para><emphasis>Instead of:</emphasis></para>
662 <para>if ( condition ) { structure->flag = 1; } else {
663 structure->flag = 0; }</para>
665 <para><emphasis>Note:</emphasis> The former is readable and consice. The later
666 is wordy and inefficient. Please assume that any developer new
667 to the project has at least a "good" knowledge of C/C++. (Hope
668 I do not offend by that last comment ... 8-)</para>
674 <sect3 id="s19"><title>Use white space freely because it is
677 <para><emphasis>Explanation:</emphasis></para>
679 <para>Make it readable. The notable exception to using white space
680 freely is listed in the next guideline.</para>
682 <para><emphasis>Example:</emphasis></para>
686 int anotherValue = 0;
687 int thisVariable = 0;
689 if ( thisVariable == thatVariable )
691 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
696 <sect3 id="s20"><title>Don't use white space around structure
699 <para><emphasis>Explanation:</emphasis></para>
701 <para>- structure pointer operator ( "->" ) - member operator (
702 "." ) - functions and parentheses</para>
704 <para>It is a general coding practice to put pointers, references,
705 and function parentheses next to names. With spaces, the
706 connection between the object and variable/function name is not
709 <para><emphasis>Example:</emphasis></para>
713 FunctionName();</programlisting>
715 <para><emphasis>Instead of:</emphasis> aStruct -> aMember; aStruct . aMember;
716 FunctionName ();</para>
722 <sect3 id="s21"><title>Make the last brace of a function stand
725 <para><emphasis>Example:</emphasis></para>
732 } /* -END- function1 */
737 } /* -END- function2 */
740 <para><emphasis>Instead of:</emphasis></para>
742 <para>int function1( ... ) { ...code... return( retCode ); } int
743 function2( ... ) { }</para>
745 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
746 lines afterwards. This makes the end of function standout to
747 the most casual viewer. Although function comments help
748 seperate functions, this is still a good coding practice. In
749 fact, I follow these rules when using blocks in "for", "while",
750 "do" loops, and long if {} statements too. After all whitespace
753 <para><emphasis>Status:</emphasis> developer-discrection on the number of blank
754 lines. Enforced is the end of function comments.</para>
760 <sect3 id="s22"><title>Use 3 character indentions</title>
762 <para><emphasis>Explanation:</emphasis></para>
764 <para>If some use 8 character TABs and some use 3 character TABs,
765 the code can look *very* ragged. So use 3 character indentions
766 only. If you like to use TABs, pass your code through a filter
767 such as "expand -t3" before checking in your code.</para>
769 <para><emphasis>Example:</emphasis></para>
771 static const char * const url_code_map[256] =
781 return( ALWAYS_TRUE );
785 return( HOW_DID_YOU_GET_HERE );
788 return( NEVER_GETS_HERE );
797 <sect2 id="s23"><title>Initializing</title>
801 <sect3 id="s24"><title>Initialize all variables</title>
803 <para><emphasis>Explanation:</emphasis></para>
805 <para>Do not assume that the variables declared will not be used
806 until after they have been assigned a value somewhere else in
807 the code. Remove the chance of accidentally using an unassigned
810 <para><emphasis>Example:</emphasis></para>
814 struct *ptr = NULL;</programlisting>
816 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
817 message says you are trying to access memory address 00000000
818 and not 129FA012; or arrayPtr[20] causes a SIGSEV vs.
821 <para><emphasis>Status:</emphasis> developer-discrection if and only if the
822 variable is assigned a value "shortly after" declaration.</para>
828 <sect2 id="s25"><title>Functions</title>
832 <sect3 id="s26"><title>Name functions that return a boolean as a
835 <para><emphasis>Explanation:</emphasis></para>
837 <para>Value should be phrased as a question that would logically
838 be answered as a true or false statement</para>
840 <para><emphasis>Example:</emphasis></para>
849 <sect3 id="s27"><title>Always specify a return type for a
852 <para><emphasis>Explanation:</emphasis></para>
854 <para>The default return for a function is an int. To avoid
855 ambiguity, create a return for a function when the return has a
856 purpose, and create a void return type if the function does not
857 need to return anything.</para>
863 <sect3 id="s28"><title>Minimize function calls when iterating by
864 using variables</title>
866 <para><emphasis>Explanation:</emphasis></para>
868 <para>It is easy to write the following code, and a clear argument
869 can be made that the code is easy to understand:</para>
871 <para><emphasis>Example:</emphasis></para>
873 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
878 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
879 each and every iteration. This increases the overhead in the
880 program, because the compiler has to look up the function each
881 time, call it, and return a value. Depending on what occurs in
882 the blockListLength() call, it might even be creating and
883 destroying structures with each iteration, even though in each
884 case it is comparing "cnt" to the same value, over and over.
885 Remember too - even a call to blockListLength() is a function
886 call, with the same overhead.</para>
888 <para>Instead of using a function call during the iterations,
889 assign the value to a variable, and evaluate using the
892 <para><emphasis>Example:</emphasis></para>
894 size_t len = blockListLength();
896 for ( size_t cnt = 0; cnt < len; cnt ++ )
901 <para><emphasis>Exceptions:</emphasis> if the value of blockListLength() *may*
902 change or could *potentially* change, then you must code the
903 function call in the for/while loop.</para>
909 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
911 <para><emphasis>Explanation:</emphasis></para>
913 <para>This allows a developer to define a const pointer and call
914 your function. If your function does not have the const
915 keyword, we may not be able to use your function. Consider
916 strcmp, if it were defined as: extern int strcmp( char *s1,
919 <para>I could then not use it to compare argv's in main: int main(
920 int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
923 <para>Both these pointers are *const*! If the c runtime library
924 maintainers do it, we should too.</para>
930 <sect3 id="s30"><title>Pass and Return by Value</title>
932 <para><emphasis>Explanation:</emphasis></para>
934 <para>Most structures cannot fit onto a normal stack entry (i.e.
935 they are not 4 bytes or less). Aka, a function declaration
936 like: int load_aclfile( struct client_state csp )</para>
938 <para>would not work. So, to be consistent, we should declare all
939 prototypes with "pass by value": int load_aclfile( struct
940 client_state *csp )</para>
946 <sect3 id="s31"><title>Names of include files</title>
948 <para><emphasis>Explanation:</emphasis></para>
950 <para>Your include statements should contain the file name without
951 a path. The path should be listed in the Makefile, using -I as
952 processor directive to search the indicated paths. An exception
953 to this would be for some proprietary software that utilizes a
954 partial path to distinguish their header files from system or
955 other header files.</para>
957 <para><emphasis>Example:</emphasis></para>
959 #include <iostream.h> /* This is not a local include */
960 #include "config.h" /* This IS a local include */
963 <para><emphasis>Exception:</emphasis></para>
967 /* This is not a local include, but requires a path element. */
968 #include <sys/fileName.h>
972 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
973 without a _very_ good reason. This duplicates the #include
974 "file.h" behaviour.</para>
980 <sect3 id="s32"><title>Provide multiple inclusion
983 <para><emphasis>Explanation:</emphasis></para>
985 <para>Prevents compiler and linker errors resulting from
986 redefinition of items.</para>
988 <para>Wrap each header file with the following syntax to prevent
989 multiple inclusions of the file. Of course, replace PROJECT_H
990 with your file name, with "." Changed to "_", and make it
993 <para><emphasis>Example:</emphasis></para>
995 #ifndef PROJECT_H_INCLUDED
996 #define PROJECT_H_INCLUDED
998 #endif /* ndef PROJECT_H_INCLUDED */
1003 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1005 <para><emphasis>Explanation:</emphasis></para>
1007 <para>If our headers are included from C++, they must declare our
1008 functions as `extern "C"`. This has no cost in C, but increases
1009 the potential re-usability of our code.</para>
1011 <para><emphasis>Example:</emphasis></para>
1016 #endif /* def __cplusplus */
1018 ... function definitions here ...
1022 #endif /* def __cplusplus */
1027 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1028 Declaration Instead of Includes</title>
1030 <para><emphasis>Explanation:</emphasis></para>
1032 <para>Useful in headers that include pointers to other struct's.
1033 Modifications to excess header files may cause needless
1036 <para><emphasis>Example:</emphasis></para>
1038 /*********************************************************************
1039 * We're avoiding an include statement here!
1040 *********************************************************************/
1042 extern file_list *xyz;</programlisting>
1044 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1045 pointer), then including the proper header file is necessary.
1046 If you only want to prototype a pointer, however, the header
1047 file is unneccessary.</para>
1049 <para><emphasis>Status:</emphasis> Use with discrection.</para>
1055 <sect2 id="s35"><title>General Coding Practices</title>
1059 <sect3 id="s36"><title>Turn on warnings</title>
1061 <para><emphasis>Explanation</emphasis></para>
1063 <para>Compiler warnings are meant to help you find bugs. You
1064 should turn on as many as possible. With GCC, the switch is
1065 "-Wall". Try and fix as many warnings as possible.</para>
1071 <sect3 id="s37"><title>Provide a default case for all switch
1074 <para><emphasis>Explanation:</emphasis></para>
1076 <para>What you think is guaranteed is never really guaranteed. The
1077 value that you don't think you need to check is the one that
1078 someday will be passed. So, to protect yourself from the
1079 unknown, always have a default step in a switch statement.</para>
1081 <para><emphasis>Example:</emphasis></para>
1083 switch( hash_string( cmd ) )
1085 case hash_actions_file :
1095 ... anomly code goes here ...
1096 continue; / break; / exit( 1 ); / etc ...
1098 } /* end switch( hash_string( cmd ) ) */</programlisting>
1100 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1101 are obviously exempt from this point. Of note, most of the
1102 WIN32 code calls `DefWindowProc' after the switch statement.
1103 This API call *should* be included in a default statement.</para>
1105 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1106 as a robust programming issue. The "anomly code goes here" may
1107 be no more than a print to the STDERR stream (as in
1108 load_config). Or it may really be an ABEND condition.</para>
1110 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1116 <sect3 id="s38"><title>Try to avoid falling through cases in a
1117 switch statement.</title>
1119 <para><emphasis>Explanation:</emphasis></para>
1121 <para>In general, you will want to have a 'break' statement within
1122 each 'case' of a switch statement. This allows for the code to
1123 be more readable and understandable, and furthermore can
1124 prevent unwanted surprises if someone else later gets creative
1125 and moves the code around.</para>
1127 <para>The language allows you to plan the fall through from one
1128 case statement to another simply by omitting the break
1129 statement within the case statement. This feature does have
1130 benefits, but should only be used in rare cases. In general,
1131 use a break statement for each case statement.</para>
1133 <para>If you choose to allow fall through, you should comment both
1134 the fact of the fall through and reason why you felt it was
1141 <sect3 id="s39"><title>Use 'long' or 'short' Instead of
1144 <para><emphasis>Explanation:</emphasis></para>
1146 <para>On 32-bit platforms, int usually has the range of long. On
1147 16-bit platforms, int has the range of short.</para>
1149 <para><emphasis>Status:</emphasis> open-to-debate. In the case of most FSF
1150 projects (including X/GNU-Emacs), there are typedefs to int4,
1151 int8, int16, (or equivalence ... I forget the exact typedefs
1152 now). Should we add these to IJB now that we have a "configure"
1159 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1161 <para><emphasis>Explanation:</emphasis></para>
1163 <para>The type of size_t varies across platforms. Do not make
1164 assumptions about whether it is signed or unsigned, or about
1165 how long it is. Do not compare a size_t against another
1166 variable of a different type (or even against a constant)
1167 without casting one of the values. Try to avoid using size_t if
1174 <sect3 id="s41"><title>Declare each variable and struct on its
1177 <para><emphasis>Explanation:</emphasis></para>
1179 <para>It can be tempting to declare a series of variables all on
1180 one line. Don't.</para>
1182 <para><emphasis>Example:</emphasis></para>
1186 long c = 0;</programlisting>
1188 <para><emphasis>Instead of:</emphasis></para>
1190 <para>long a, b, c;</para>
1192 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1193 individual variables - easier to add new variables without
1194 messing up the original ones - when searching on a variable to
1195 find its type, there is less clutter to "visually"
1198 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1199 variables or other trivial variables; feel free to declare them
1200 on 1 line. You should, although, provide a good comment on
1201 their functions.</para>
1203 <para><emphasis>Status:</emphasis> developer-discrection.</para>
1209 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1211 <para><emphasis>Explanation:</emphasis></para>
1213 <para>Create a local stuct (on the stack) if the variable will
1214 live and die within the context of one function call.</para>
1216 <para>Only "malloc" a struct (on the heap) if the variable's life
1217 will extend beyond the context of one function call.</para>
1219 <para><emphasis>Example:</emphasis></para>
1221 If a function creates a struct and stores a pointer to it in a
1222 list, then it should definately be allocated via `malloc'.
1227 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1228 Responsible for Ensuring 'free'</title>
1230 <para><emphasis>Explanation:</emphasis></para>
1232 <para>If you have to "malloc" an instance, you are responsible for
1233 insuring that the instance is `free'd, even if the deallocation
1234 event falls within some other programmer's code. You are also
1235 responsible for ensuring that deletion is timely (i.e. not too
1236 soon, not too late). This is known as "low-coupling" and is a
1237 "good thing (tm)". You may need to offer a
1238 free/unload/destuctor type function to accomodate this.</para>
1240 <para><emphasis>Example:</emphasis></para>
1242 int load_re_filterfile( struct client_state *csp ) { ... }
1243 static void unload_re_filterfile( void *f ) { ... }</programlisting>
1245 <para><emphasis>Exceptions:</emphasis></para>
1247 <para>The developer cannot be expected to provide `free'ing
1248 functions for C run-time library functions ... such as
1251 <para><emphasis>Status:</emphasis> developer-discrection. The "main" use of this
1252 standard is for allocating and freeing data structures (complex
1259 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1260 and in order</title>
1262 <para><emphasis>Explanation:</emphasis></para>
1264 <para>I have ordered all of the "blocker" file code to be in alpha
1265 order. It is easier to add/read new blockers when you expect a
1266 certain order.</para>
1268 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1269 places by POPUP tests coming before PCRS tests. But since
1270 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1271 it should come first.</para>
1277 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1278 exitinst code, use FIXME</title>
1280 <para><emphasis>Explanation:</emphasis></para>
1282 <para>If you have enough confidence in new code or confidence in
1283 your changes, but are not *quite* sure of the reprocussions,
1286 <para>/* FIXME: this code has a logic error on platform XYZ, *
1287 attempthing to fix */ #ifdef PLATFORM ...changed code here...
1292 <para>/* FIXME: I think the original author really meant this...
1293 */ ...changed code here...</para>
1297 <para>/* FIXME: new code that *may* break something else... */
1298 ...new code here...</para>
1300 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1301 be a "good thing (tm)", it will be easier to identify and
1302 include in the project (or conversly exclude from the
1310 <sect2 id="s46"><title>Addendum: Template for files and function
1311 comment blocks:</title>
1313 <para><emphasis>Example for file comments:</emphasis></para>
1315 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.17 2002/04/03 01:21:17 hal9 Exp $";
1316 /*********************************************************************
1318 * File : $S<!-- Break CVS Substitution -->ource$
1320 * Purpose : (Fill me in with a good description!)
1322 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1323 * Privoxy team. http://www.privoxy.org/
1325 * Based on the Internet Junkbuster originally written
1326 * by and Copyright (C) 1997 Anonymous Coders and
1327 * Junkbusters Corporation. http://www.junkbusters.com
1329 * This program is free software; you can redistribute it
1330 * and/or modify it under the terms of the GNU General
1331 * Public License as published by the Free Software
1332 * Foundation; either version 2 of the License, or (at
1333 * your option) any later version.
1335 * This program is distributed in the hope that it will
1336 * be useful, but WITHOUT ANY WARRANTY; without even the
1337 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1338 * PARTICULAR PURPOSE. See the GNU General Public
1339 * License for more details.
1341 * The GNU General Public License should be included with
1342 * this file. If not, you can view it at
1343 * http://www.gnu.org/copyleft/gpl.html
1344 * or write to the Free Software Foundation, Inc., 59
1345 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1348 * $L<!-- Break CVS Substitution -->og$
1350 *********************************************************************/
1355 ...necessary include files for us to do our work...
1357 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1360 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1361 added to the "show-proxy-args" page. If this is a brand new
1362 creation by you, you are free to change the "Copyright" section
1363 to represent the rights you wish to maintain.</para>
1365 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1366 after the comment flower box is handy for (X|GNU)Emacs users to
1367 skip the verbige and get to the heart of the code (via
1368 `forward-page' and `backward-page'). Please include it if you
1371 <para><emphasis>Example for file header comments:</emphasis></para>
1375 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.17 2002/04/03 01:21:17 hal9 Exp $"
1376 /*********************************************************************
1378 * File : $S<!-- Break CVS Substitution -->ource$
1380 * Purpose : (Fill me in with a good description!)
1382 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1383 * Privoxy team. http://www.privoxy.org/
1385 * Based on the Internet Junkbuster originally written
1386 * by and Copyright (C) 1997 Anonymous Coders and
1387 * Junkbusters Corporation. http://www.junkbusters.com
1389 * This program is free software; you can redistribute it
1390 * and/or modify it under the terms of the GNU General
1391 * Public License as published by the Free Software
1392 * Foundation; either version 2 of the License, or (at
1393 * your option) any later version.
1395 * This program is distributed in the hope that it will
1396 * be useful, but WITHOUT ANY WARRANTY; without even the
1397 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1398 * PARTICULAR PURPOSE. See the GNU General Public
1399 * License for more details.
1401 * The GNU General Public License should be included with
1402 * this file. If not, you can view it at
1403 * http://www.gnu.org/copyleft/gpl.html
1404 * or write to the Free Software Foundation, Inc., 59
1405 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1408 * $L<!-- Break CVS Substitution -->og$
1410 *********************************************************************/
1413 #include "project.h"
1419 ... function headers here ...
1422 /* Revision control strings from this header and associated .c file */
1423 extern const char FILENAME_rcs[];
1424 extern const char FILENAME_h_rcs[];
1431 #endif /* ndef _FILENAME_H */
1440 <para><emphasis>Example for function comments:</emphasis></para>
1442 /*********************************************************************
1444 * Function : FUNCTION_NAME
1446 * Description : (Fill me in with a good description!)
1449 * 1 : param1 = pointer to an important thing
1450 * 2 : x = pointer to something else
1452 * Returns : 0 => Ok, everything else is an error.
1454 *********************************************************************/
1455 int FUNCTION_NAME( void *param1, const char *x )
1463 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1464 able to parse our code to create a "self-documenting" web
1471 <!-- ~~~~~ New section ~~~~~ -->
1472 <sect1 id="cvs"><title>Version Control Guidelines</title>
1473 <para>To be filled. note on cvs comments. Don't only comment what you did,
1474 but also why you did it!
1478 <!-- ~~~~~ New section ~~~~~ -->
1479 <sect1 id="testing"><title>Testing Guidelines</title>
1483 <!-- ~~~~~ New section ~~~~~ -->
1484 <sect2 id="testing-plan"><title>Testplan for releases</title>
1486 Explain release numbers. major, minor. developer releases. etc.
1488 <orderedlist numeration="arabic">
1490 Remove any existing rpm with rpm -e
1493 Remove any file that was left over. This includes (but is not limited to)
1495 <listitem><para>/var/log/privoxy</para></listitem>
1496 <listitem><para>/etc/privoxy</para></listitem>
1497 <listitem><para>/usr/sbin/privoxy</para></listitem>
1498 <listitem><para>/etc/init.d/privoxy</para></listitem>
1499 <listitem><para>/usr/doc/privoxy*</para></listitem>
1503 Install the rpm. Any error messages?
1505 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1506 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1507 autostart work?</para></listitem>
1508 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1509 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1514 <!-- ~~~~~ New section ~~~~~ -->
1515 <sect2 id="testing-report"><title>Test reports</title>
1517 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
1518 at sourceforge. Three simple steps:
1521 <listitem><para>Select category: the distribution you test on.</para></listitem>
1522 <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
1523 <listitem><para>Fill the Summary and Detailed Description with something
1524 intelligent (keep it short and precise).</para>
1527 Do not mail to the mailinglist (we cannot keep track on issues there).
1533 <!-- ~~~~~ New section ~~~~~ -->
1534 <sect1 id="newrelease"><title>Releasing a new version</title>
1536 To minimize trouble with distribution contents, webpage
1537 errors and the like, we strongly encourage you
1538 to follow this section if you prepare a new release of
1539 code or new pages on the webserver.
1542 The following programs are required to follow this process:
1543 <filename>ncftpput</filename> (ncftp), <filename>scp</filename> (ssh),
1544 <filename>gmake</filename> (GNU's version of make), autoconf, cvs, ???.
1547 <sect2 id="beforerelease">
1548 <title>Before the Release</title>
1550 The following <emphasis>must be done by one of the
1551 developers</emphasis> prior to each new release:
1557 Make sure that everybody who has worked on the code in the last
1558 couple of days has had a chance to yell <quote>no!</quote> in case
1559 they have pending changes/fixes in their pipelines.
1564 Increment the version number in <filename>configure.in</filename> in
1565 CVS. Also, the RPM release number in
1566 <filename>configure.in</filename>. Do NOT touch version information
1567 after export from CVS. <emphasis>All packages</emphasis> will use the
1568 version and release data from <filename>configure.in</filename>.
1569 Local files should not be changed, except prior to a CVS commit!!!
1570 This way we are all on the same page!
1575 If the default actionsfile has changed since last release,
1576 bump up its version info in this line:
1580 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
1584 Then change the version info in doc/webserver/actions/index.php,
1585 line: '$required_actions_file_version = "A.B";'
1590 Tag all files in CVS with the version number with
1591 <quote><command>cvs tag v_X_Y_Z</command></quote> (where X = major, Y
1592 = minor, Z = point). Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work)
1598 The first package uploaded should be the official
1599 <quote>tarball</quote> release. This is built with the
1600 <quote><command>make tarball-dist</command></quote> Makefile
1601 target, and then can be uploaded with
1602 <quote><command>make tarball-upload</command></quote> (see below).
1609 <sect2 id="newrelease-web"><title>Update the webserver</title>
1611 All files must be group-readable and group-writable (or no one else
1612 will be able to change them). To update the webserver, create any
1613 pages locally in the <filename>doc/webserver</filename> directory (or
1614 create new directories under <filename>doc/webserver</filename>), then do
1622 Note that <quote><command>make dok</command></quote>
1623 (or <quote><command>make redhat-dok</command></quote>) creates
1624 <filename>doc/webserver/user-manual</filename>,
1625 <filename>doc/webserver/developer-manual</filename>,
1626 <filename>doc/webserver/faq</filename> and
1627 <filename>doc/webserver/man-page</filename> automatically.
1630 Please do NOT use any other means of transferring files to the
1631 webserver. <quote><command>make webserver</command></quote> not only
1632 uploads, but will make sure that the appropriate permissions are
1633 preserved for shared group access.
1637 <sect2 id="newrelease-rpm"><title>SuSE or Red Hat</title>
1639 Ensure that you have the latest code version. Hence run:
1644 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1645 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1653 autoheader && autoconf && ./configure
1661 make suse-dist or make redhat-dist
1665 To upload the package to Sourceforge, simply issue
1669 make suse-upload or make redhat-upload
1673 Go to the displayed URL and release the file publicly on Sourceforge.
1677 <sect2 id="newrelease-os2"><title>OS/2</title>
1679 Ensure that you have the latest code version. Hence run:
1684 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1685 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1693 autoheader && autoconf && ./configure
1701 <sect2 id="newrelease-solaris"><title>Solaris</title>
1703 Login to Sourceforge's compilefarm via ssh
1707 ssh cf.sourceforge.net
1711 Choose the right operating system (not the Debian one). If you have
1712 downloaded <application>Privoxy</application> before,
1717 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1718 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1722 If not, please <ulink
1723 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
1724 Privoxy via CVS first</ulink>. Run:
1728 autoheader && autoconf && ./configure
1740 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
1741 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
1742 to manually upload the archive to Sourceforge's ftp server and release
1747 <sect2 id="newrelease-windows"><title>Windows</title>
1749 Ensure that you have the latest code version. Hence run
1754 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1755 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1763 autoheader && autoconf && ./configure
1771 <sect2 id="newrelease-debian"><title>Debian</title>
1773 Ensure that you have the latest code version. Hence run:
1778 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1779 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1787 autoheader && autoconf && ./configure
1795 <sect2 id="newrelease-macosx"><title>Mac OSX</title>
1797 Login to Sourceforge's compilefarm via ssh
1801 ssh cf.sourceforge.net
1805 Choose the right operating system. If you have downloaded Privoxy
1811 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1812 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1816 If not, please <ulink
1817 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
1818 Privoxy via CVS first</ulink>. Run:
1822 autoheader && autoconf && ./configure
1834 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
1835 macosx-upload</command> on the Sourceforge machine (no ncftpput). You now have
1836 to manually upload the archive to Sourceforge's ftp server and release
1841 <sect2 id="newrelease-freebsd"><title>FreeBSD</title>
1843 Change the version number of <application>Privoxy</application> in the
1844 configure.in file. Run:
1846 autoheader && autoconf && ./configure
1851 Login to Sourceforge's compilefarm via ssh:
1855 ssh cf.sourceforge.net
1859 Choose the right operating system. If you have downloaded Privoxy
1865 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1866 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1870 If not, please <ulink
1871 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
1872 Privoxy via CVS first</ulink>. Run:
1876 autoheader && autoconf && ./configure
1888 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
1889 freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
1890 to manually upload the archive to Sourceforge's ftp server and release
1895 <sect2 id="newrelease-tarball"><title>Tarball</title>
1897 Ensure that you have the latest code version. Hence run:
1902 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1903 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1912 autoheader && autoconf && ./configure
1924 To upload the package to Sourceforge, simply issue
1932 Goto the displayed URL and release the file publicly on Sourceforge.
1936 <sect2 id="newrelease-hpux"><title>HP-UX 11</title>
1938 Ensure that you have the latest code version. Hence run:
1943 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1944 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1952 autoheader && autoconf && ./configure
1960 <sect2 id="newrelease-amiga"><title>Amiga OS</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-aix"><title>AIX</title>
1986 Login to Sourceforge's compilefarm via ssh:
1990 ssh cf.sourceforge.net
1994 Choose the right operating system. If you have downloaded Privoxy
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
2005 If not, please <ulink
2006 url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
2007 Privoxy via CVS first</ulink>. Run:
2011 autoheader && autoconf && ./configure
2023 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2024 aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
2025 to manually upload the archive to Sourceforge's ftp server and release
2032 <!-- ~~~~~ New section ~~~~~ -->
2033 <sect1 id="contact"><title>Contact the developers</title>
2035 Please see the contact page in the <ulink
2036 url="../user-manual/contact.html">user-manual</ulink> for details.
2040 <!-- ~~~~~ New section ~~~~~ -->
2041 <sect1 id="copyright"><title>Copyright and History</title>
2043 Please see the <ulink
2044 url="../user-manual/copyright.html#HISTORY">user-manual</ulink> for
2045 information on Copyright and History.
2049 <!-- ~~~~~ New section ~~~~~ -->
2050 <sect1 id="seealso"><title>See also</title>
2052 Please see the <ulink
2053 url="../user-manual/seealso.html">user-manual</ulink> for others
2060 This program is free software; you can redistribute it
2061 and/or modify it under the terms of the GNU General
2062 Public License as published by the Free Software
2063 Foundation; either version 2 of the License, or (at
2064 your option) any later version.
2066 This program is distributed in the hope that it will
2067 be useful, but WITHOUT ANY WARRANTY; without even the
2068 implied warranty of MERCHANTABILITY or FITNESS FOR A
2069 PARTICULAR PURPOSE. See the GNU General Public
2070 License for more details.
2072 The GNU General Public License should be included with
2073 this file. If not, you can view it at
2074 http://www.gnu.org/copyleft/gpl.html
2075 or write to the Free Software Foundation, Inc., 59
2076 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2078 $Log: developer-manual.sgml,v $
2079 Revision 1.17 2002/04/03 01:21:17 hal9
2080 Implementing Andreas's suggestions for Release sections.
2082 Revision 1.16 2002/03/31 23:04:40 hal9
2083 Fleshed out the doc section, and added something for an intro so it was not
2086 Revision 1.15 2002/03/30 22:29:47 swa
2089 Revision 1.14 2002/03/30 19:04:08 swa
2090 people release differently. no good.
2091 I want to make parts of the docs only.
2093 Revision 1.13 2002/03/27 01:16:41 hal9
2096 Revision 1.12 2002/03/27 01:02:51 hal9
2097 Touch up on name change...
2099 Revision 1.11 2002/03/26 22:29:55 swa
2100 we have a new homepage!
2102 Revision 1.10 2002/03/24 12:33:01 swa
2105 Revision 1.9 2002/03/24 11:01:05 swa
2108 Revision 1.8 2002/03/23 15:13:11 swa
2109 renamed every reference to the old name with foobar.
2110 fixed "application foobar application" tag, fixed
2111 "the foobar" with "foobar". left junkbustser in cvs
2112 comments and remarks to history untouched.
2114 Revision 1.7 2002/03/11 13:13:27 swa
2115 correct feedback channels
2117 Revision 1.6 2002/02/24 14:25:06 jongfoster
2118 Formatting changes. Now changing the doctype to DocBook XML 4.1
2119 will work - no other changes are needed.
2121 Revision 1.5 2001/10/31 18:16:51 swa
2122 documentation added: howto generate docs in text and html
2123 format, howto move stuff to the webserver.
2125 Revision 1.4 2001/09/23 10:13:48 swa
2126 upload process established. run make webserver and
2127 the documentation is moved to the webserver. documents
2128 are now linked correctly.
2130 Revision 1.3 2001/09/13 15:27:40 swa
2133 Revision 1.2 2001/09/13 15:20:17 swa
2134 merged standards into developer manual
2136 Revision 1.1 2001/09/12 15:36:41 swa
2137 source files for junkbuster documentation
2139 Revision 1.3 2001/09/10 17:43:59 swa
2140 first proposal of a structure.
2142 Revision 1.2 2001/06/13 14:28:31 swa
2143 docs should have an author.
2145 Revision 1.1 2001/06/13 14:20:37 swa
2146 first import of project's documentation for the webserver.