1 Privoxy Developer Manual
5 $Id: developer-manual.sgml,v 1.35 2002/04/17 15:16:15 oes Exp $
7 The developer manual gives the users information on how to help the developer
8 team. It provides guidance on coding, testing, documentation and other issues.
10 You can find the latest version of the this manual at http://www.privoxy.org/
11 developer-manual/. Please see the Contact section on how to contact the
14 -------------------------------------------------------------------------------
19 3. Quickstart to Privoxy Development
23 4.2. CVS Commit Guideline
24 4.3. Discussing Changes First
26 5. Documentation Guidelines
28 5.1. Quickstart to Docbook and SGML
29 5.2. Privoxy Documentation Style
30 5.3. Privoxy Custom Entities
37 6.2.1. Comment, Comment, Comment
38 6.2.2. Use blocks for comments
39 6.2.3. Keep Comments on their own line
40 6.2.4. Comment each logical step
41 6.2.5. Comment All Functions Thoroughly
42 6.2.6. Comment at the end of braces if the content is more than one
45 6.3. Naming Conventions
49 6.3.3. Header file prototypes
50 6.3.4. Enumerations, and #defines
55 6.4.1. Put braces on a line by themselves.
56 6.4.2. ALL control statements should have a block
57 6.4.3. Do not belabor/blow-up boolean expressions
58 6.4.4. Use white space freely because it is free
59 6.4.5. Don't use white space around structure operators
60 6.4.6. Make the last brace of a function stand out
61 6.4.7. Use 3 character indentions
65 6.5.1. Initialize all variables
69 6.6.1. Name functions that return a boolean as a question.
70 6.6.2. Always specify a return type for a function.
71 6.6.3. Minimize function calls when iterating by using variables
72 6.6.4. Pass and Return by Const Reference
73 6.6.5. Pass and Return by Value
74 6.6.6. Names of include files
75 6.6.7. Provide multiple inclusion protection
76 6.6.8. Use `extern "C"` when appropriate
77 6.6.9. Where Possible, Use Forward Struct Declaration Instead of
80 6.7. General Coding Practices
82 6.7.1. Turn on warnings
83 6.7.2. Provide a default case for all switch statements
84 6.7.3. Try to avoid falling through cases in a switch statement.
85 6.7.4. Use 'long' or 'short' Instead of 'int'
86 6.7.5. Don't mix size_t and other types
87 6.7.6. Declare each variable and struct on its own line.
88 6.7.7. Use malloc/zalloc sparingly
89 6.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
91 6.7.9. Add loaders to the `file_list' structure and in order
92 6.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
94 6.8. Addendum: Template for files and function comment blocks:
98 7.1. Testplan for releases
101 8. Releasing a New Version
103 8.1. Before the Release
104 8.2. Building and Releasing the Packages
106 8.2.1. Source Tarball
107 8.2.2. SuSE or Red Hat
118 8.3. After the Release
120 9. Update the Webserver
121 10. Contacting the developers, Bug Reporting and Feature Requests
122 11. Copyright and History
129 -------------------------------------------------------------------------------
133 Privoxy, as an heir to Junkbuster, is an Open Source project and licensed under
134 the GPL. As such, Privoxy development is potentially open to anyone who has the
135 time, knowledge, and desire to contribute in any capacity. Our goals are simply
136 to continue the mission, to improve Privoxy, and to make it available to as
137 wide an audience as possible.
139 One does not have to be a programmer to contribute. Packaging, testing, and
140 porting, are all important jobs as well.
142 -------------------------------------------------------------------------------
144 3. Quickstart to Privoxy Development
146 You'll need an account on Sourceforge to support our development. Mail your ID
147 to the list and wait until a project manager has added you.
149 For the time being (read, this section is under construction), please refer to
150 the extensive comments in the source code.
152 -------------------------------------------------------------------------------
154 4. The CVS Repository
156 If you intend to help us with programming, documentation or packaging you will
157 need write access to our holy grail, the CVS repository. Please read this
158 chapter completely before accessing via CVS.
160 -------------------------------------------------------------------------------
164 The project's CVS repository is hosted on SourceForge. Please refer to the
165 chapters 6 and 7 in SF's site documentation for the technical access details
166 for your operating system. For historical reasons, the CVS server is called
167 cvs.ijbswa.sourceforge.net, the repository is called ijbswa, and the source
168 tree module is called current.
170 -------------------------------------------------------------------------------
172 4.2. CVS Commit Guideline
174 The source tree is the heart of every software project. Every effort must be
175 made to ensure that it is readable, compilable and consistent at all times. We
176 therefore ask anyone with CVS access to strictly adhere to the following
179 * Never (read: never, ever) be tempted to commit that small change without
180 testing it thoroughly first. When we're close to a public release, ask a
181 fellow developer to review your changes.
183 * Your commit message should give a concise overview of what you changed (no
184 big details) and why you changed it Just check previous messages for good
187 * Don't use the same message on multiple files, unless it equally applies to
190 * If your changes span multiple files, and the code won't recompile unless
191 all changes are commited (e.g. when changing the signature of a function),
192 then commit all files one after another, without long delays in beween. If
193 necessary, prepare the commit messages in advance.
195 * Before changing things on CVS, make sure that your changes are in line with
196 the team's general consensus on what should be done (see below).
198 -------------------------------------------------------------------------------
200 4.3. Discussing Changes First
202 We don't have a too formal policy on this, just use common sense. Hints: If it
205 1. ..a bugfix / clean-up / cosmetic thing: shoot
207 2. ..a new feature that can be turned off: shoot
209 3. ..a clear improvement w/o side effects on other parts of the code: shoot
211 4. ..a matter of taste: ask the list
213 5. ..a major redesign of some part of the code: ask the list
215 Note that near a major public release, we get a bit more cautious - if unsure,
216 it doesn't hurt to ask first. There is always the possibility to submit a patch
217 to the patches tracker instead.
219 -------------------------------------------------------------------------------
221 5. Documentation Guidelines
223 All formal documents are maintained in Docbook SGML and located in the doc/
224 source/* directory. You will need Docbook, the Docbook DTD's and the Docbook
225 modular stylesheets (or comparable alternatives), and either jade or openjade
226 (recommended) installed in order to build docs from source. Currently there is
227 user-manual, FAQ, and, of course this, the developer-manual in this format. The
228 README, AUTHORS privoxy.1 (man page) files are also now maintained as Docbook
229 SGML. The finished files are all in the top-level source directory are
230 generated files! Also, index.html, the Privoxy home page, is maintained as
231 SGML. DO NOT edit these directly. Edit the SGML source, or contact someone
232 involved in the documentation (at present Stefan and Hal).
234 Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain
235 text files in the top-level source directory. At least for the time being.
237 Packagers are encouraged to include this documentation. For those without the
238 ability to build the docs locally, text versions of each are kept in CVS. HTML
239 versions are also now being kept in CVS under doc/webserver/*.
241 Formal documents are built with the Makefile targets of make dok, or
242 alternately make redhat-dok. If you have problems, try both. The build process
243 uses the document SGML sources in doc/source/*/* to update all text files in
244 doc/text/ and to update all HTML documents in doc/webserver/.
246 Documentation writers should please make sure documents build successfully
247 before committing to CVS, if possible.
249 How do you update the webserver (i.e. the pages on privoxy.org)?
251 1. First, build the docs by running make dok (or alternately make redhat-dok).
253 2. Run make webserver which copies all files from doc/webserver to the
254 sourceforge webserver via scp.
256 Finished docs should be occasionally submitted to CVS (doc/webserver/*/*.html)
257 so that those without the ability to build them locally, have access to them if
258 needed. This is especially important just prior to a new release! Please do
259 this after the $VERSION and other release specific data in configure.in has
260 been updated (this is done just prior to a new release).
262 -------------------------------------------------------------------------------
264 5.1. Quickstart to Docbook and SGML
266 If you are not familiar with SGML, it is a markup language similar to HTML.
267 Actually, not a mark up language per se, but a language used to define markup
268 languages. In fact, HTML is an SGML application. Both will use "tags" to format
269 text and other content. SGML tags can be much more varied, and flexible, but do
270 much of the same kinds of things. The tags, or "elements", are definable in
271 SGML. There is no set "standards". Since we are using Docbook, our tags are
272 those that are defined by Docbook. Much of how the finish document is rendered
273 is determined by the "stylesheets". The stylesheets determine how each tag gets
274 translated to HTML, or other formats.
276 Tags in Docbook SGML need to be always "closed". If not, you will likely
277 generate errors. Example: <title>My Title</title>. They are also
278 case-insensitive, but we strongly suggest using all lower case. This keeps
279 compatibility with [Docbook] XML.
281 Our documents use "sections" for the most part. Sections will be processed into
282 HTML headers (e.g. h1 for sect1). The Docbook stylesheets will use these to
283 also generate the Table of Contents for each doc. Our TOC's are set to a depth
284 of three. Meaning sect1, sect2, and sect3 will have TOC entries, but sect4 will
285 not. Each section requires a <title> element, and at least one <para>. There is
286 a limit of five section levels in Docbook, but generally three should be
287 sufficient for our purposes.
289 Some common elements that you likely will use:
291 , paragraph delimiter. Most text needs to be within paragraph elements (there
292 are some exceptions).
293 , the stylesheets make this italics.
294 , files and directories.
299 , member of the above.
300 , screen output, implies .
302 , for, doh, quoting text.
304 Look at any of the existing docs for examples of all these and more.
306 You might also find "Writing Documentation Using DocBook - A Crash Course"
309 -------------------------------------------------------------------------------
311 5.2. Privoxy Documentation Style
313 It will be easier if everyone follows a similar writing style. This just makes
314 it easier to read what someone else has written if it is all done in a similar
319 * All tags should be lower case.
321 * Tags delimiting a block of text (even small blocks) should be on their own
329 Tags marking individual words, or few words, should be in-line:
331 Just to <emphasis>emphasize</emphasis>, some text goes here.
334 * Tags should be nested and step indented for block text like: (except
341 Some text goes here in our list example.
348 This makes it easier to find the text amongst the tags ;-)
350 * Use white space to separate logical divisions within a document, like
351 between sections. Running everything together consistently makes it harder
354 * Do not hesitate to make comments. Comments can either use the <comment>
355 element, or the <!-- --> style comment familiar from HTML. (Note in Docbook
356 v4.x <comment> is replaced by <remark>.)
358 * We have an international audience. Refrain from slang, or English
359 idiosyncrasies (too many to list :). Humor also does not translate well
362 * Try to keep overall line lengths in source files to 80 characters or less
363 for obvious reasons. This is not always possible, with lengthy URLs for
366 * Our documents are available in differing formats. Right now, they are just
367 plain text, and HTML, but PDF, and others is always a future possibility.
368 Be careful with URLs (<ulink>), and avoid this mistake:
370 My favorite site is <ulink url="http://example.com">here</ulink>.
372 This will render as "My favorite site is here", which is not real helpful
373 in a text doc. Better like this:
375 My favorite site is <ulink url="http://example.com">example.com</ulink>.
377 * All documents should be spell checked occasionally. aspell can check SGML
378 with the -H option. (ispell I think too.)
380 -------------------------------------------------------------------------------
382 5.3. Privoxy Custom Entities
384 Privoxy documentation is using a number of customized "entities" to facilitate
385 documentation maintenance.
387 We are using a set of "boilerplate" files with generic text, that is used by
388 multiple docs. This way we can write something once, and use it repeatedly
389 without having to re-write the same content over and over again. If editing
390 such a file, keep in mind that it should be generic. That is the purpose; so it
391 can be used in varying contexts without additional modifications.
393 We are also using what Docbook calls "internal entities". These are like
394 variables in programming. Well, sort of. For instance, we have the p-version
395 entity that contains the current Privoxy version string. You are strongly
396 encouraged to use these where possible. Some of these obviously require
397 re-setting with each release (done by the Makefile). A sampling of custom
398 entities are listed below. See any of the main docs for examples.
400 * Re- "boilerplate" text entities are defined like:
402 <!entity supported SYSTEM "supported.sgml">
404 In this example, the contents of the file, supported.sgml is available for
405 inclusion anywhere in the doc. To make this happen, just reference the now
406 defined entity: &supported; (starts with an ampersand and ends with a
407 semi-colon), and the contents will be dumped into the finished doc at that
410 * Commonly used "internal entities":
412 p-version: the Privoxy version string, e.g. "2.9.14".
413 p-status: the project status, either "alpha", "beta", or "stable".
414 p-not-stable: use to conditionally include text in "not stable" releases
416 p-stable: just the opposite.
417 p-text: this doc is only generated as text.
419 There are others in various places that are defined for a specific purpose.
422 -------------------------------------------------------------------------------
428 This set of standards is designed to make our lives easier. It is developed
429 with the simple goal of helping us keep the "new and improved Privoxy"
430 consistent and reliable. Thus making maintenance easier and increasing chances
431 of success of the project.
433 And that of course comes back to us as individuals. If we can increase our
434 development and product efficiencies then we can solve more of the request for
435 changes/improvements and in general feel good about ourselves. ;->
437 -------------------------------------------------------------------------------
441 6.2.1. Comment, Comment, Comment
445 Comment as much as possible without commenting the obvious. For example do not
446 comment "aVariable is equal to bVariable". Instead explain why aVariable should
447 be equal to the bVariable. Just because a person can read code does not mean
448 they will understand why or what is being done. A reader may spend a lot more
449 time figuring out what is going on when a simple comment or explanation would
450 have prevented the extra research. Please help your brother IJB'ers out!
452 The comments will also help justify the intent of the code. If the comment
453 describes something different than what the code is doing then maybe a
454 programming error is occurring.
458 /* if page size greater than 1k ... */
459 if ( PageLength() > 1024 )
461 ... "block" the page up ...
464 /* if page size is small, send it in blocks */
465 if ( PageLength() > 1024 )
467 ... "block" the page up ...
470 This demonstrates 2 cases of "what not to do". The first is a
471 "syntax comment". The second is a comment that does not fit what
472 is actually being done.
474 -------------------------------------------------------------------------------
476 6.2.2. Use blocks for comments
480 Comments can help or they can clutter. They help when they are differentiated
481 from the code they describe. One line comments do not offer effective
482 separation between the comment and the code. Block identifiers do, by
483 surrounding the code with a clear, definable pattern.
487 /*********************************************************************
488 * This will stand out clearly in your code!
489 *********************************************************************/
490 if ( thisVariable == thatVariable )
492 DoSomethingVeryImportant();
496 /* unfortunately, this may not */
497 if ( thisVariable == thatVariable )
499 DoSomethingVeryImportant();
503 if ( thisVariable == thatVariable ) /* this may not either */
505 DoSomethingVeryImportant();
510 If you are trying to add a small logic comment and do not wish to "disrupt" the
511 flow of the code, feel free to use a 1 line comment which is NOT on the same
514 -------------------------------------------------------------------------------
516 6.2.3. Keep Comments on their own line
520 It goes back to the question of readability. If the comment is on the same line
521 as the code it will be harder to read than the comment that is on its own line.
523 There are three exceptions to this rule, which should be violated freely and
524 often: during the definition of variables, at the end of closing braces, when
525 used to comment parameters.
529 /*********************************************************************
530 * This will stand out clearly in your code,
531 * But the second example won't.
532 *********************************************************************/
533 if ( thisVariable == thatVariable )
535 DoSomethingVeryImportant();
538 if ( thisVariable == thatVariable ) /*can you see me?*/
540 DoSomethingVeryImportant(); /*not easily*/
544 /*********************************************************************
545 * But, the encouraged exceptions:
546 *********************************************************************/
547 int urls_read = 0; /* # of urls read + rejected */
548 int urls_rejected = 0; /* # of urls rejected */
552 DoSomethingVeryImportant();
556 short DoSomethingVeryImportant(
557 short firstparam, /* represents something */
558 short nextparam /* represents something else */ )
562 } /* -END- DoSomethingVeryImportant */
564 -------------------------------------------------------------------------------
566 6.2.4. Comment each logical step
570 Logical steps should be commented to help others follow the intent of the
571 written code and comments will make the code more readable.
573 If you have 25 lines of code without a comment, you should probably go back
574 into it to see where you forgot to put one.
576 Most "for", "while", "do", etc... loops _probably_ need a comment. After all,
577 these are usually major logic containers.
579 -------------------------------------------------------------------------------
581 6.2.5. Comment All Functions Thoroughly
585 A reader of the code should be able to look at the comments just prior to the
586 beginning of a function and discern the reason for its existence and the
587 consequences of using it. The reader should not have to read through the code
588 to determine if a given function is safe for a desired use. The proper
589 information thoroughly presented at the introduction of a function not only
590 saves time for subsequent maintenance or debugging, it more importantly aids in
591 code reuse by allowing a user to determine the safety and applicability of any
592 function for the problem at hand. As a result of such benefits, all functions
593 should contain the information presented in the addendum section of this
596 -------------------------------------------------------------------------------
598 6.2.6. Comment at the end of braces if the content is more than one screen
603 Each closing brace should be followed on the same line by a comment that
604 describes the origination of the brace if the original brace is off of the
605 screen, or otherwise far away from the closing brace. This will simplify the
606 debugging, maintenance, and readability of the code.
608 As a suggestion , use the following flags to make the comment and its brace
611 use following a closing brace: } /* -END- if() or while () or etc... */
617 DoSomethingVeryImportant();
618 ...some long list of commands...
619 } /* -END- if x is 1 */
625 DoSomethingVeryImportant();
626 ...some long list of commands...
627 } /* -END- if ( 1 == X ) */
629 -------------------------------------------------------------------------------
631 6.3. Naming Conventions
633 6.3.1. Variable Names
637 Use all lowercase, and separate words via an underscore ('_'). Do not start an
638 identifier with an underscore. (ANSI C reserves these for use by the compiler
639 and system headers.) Do not use identifiers which are reserved in ANSI C++.
640 (E.g. template, class, true, false, ...). This is in case we ever decide to
645 int ms_iis5_hack = 0;
649 int msiis5hack = 0; int msIis5Hack = 0;
651 -------------------------------------------------------------------------------
653 6.3.2. Function Names
657 Use all lowercase, and separate words via an underscore ('_'). Do not start an
658 identifier with an underscore. (ANSI C reserves these for use by the compiler
659 and system headers.) Do not use identifiers which are reserved in ANSI C++.
660 (E.g. template, class, true, false, ...). This is in case we ever decide to
665 int load_some_file( struct client_state *csp )
669 int loadsomefile( struct client_state *csp )
670 int loadSomeFile( struct client_state *csp )
672 -------------------------------------------------------------------------------
674 6.3.3. Header file prototypes
678 Use a descriptive parameter name in the function prototype in header files. Use
679 the same parameter name in the header file that you use in the c file.
683 (.h) extern int load_aclfile( struct client_state *csp );
684 (.c) int load_aclfile( struct client_state *csp )
688 (.h) extern int load_aclfile( struct client_state * ); or
689 (.h) extern int load_aclfile();
690 (.c) int load_aclfile( struct client_state *csp )
692 -------------------------------------------------------------------------------
694 6.3.4. Enumerations, and #defines
698 Use all capital letters, with underscores between words. Do not start an
699 identifier with an underscore. (ANSI C reserves these for use by the compiler
704 (enumeration) : enum Boolean { FALSE, TRUE };
705 (#define) : #define DEFAULT_SIZE 100;
707 Note: We have a standard naming scheme for #defines that toggle a feature in
708 the preprocessor: FEATURE_>, where > is a short (preferably 1 or 2 word)
713 #define FEATURE_FORCE 1
716 #define FORCE_PREFIX blah
717 #endif /* def FEATURE_FORCE */
719 -------------------------------------------------------------------------------
725 Spell common words out entirely (do not remove vowels).
727 Use only widely-known domain acronyms and abbreviations. Capitalize all letters
730 Use underscore (_) to separate adjacent acronyms and abbreviations. Never
731 terminate a name with an underscore.
735 #define USE_IMAGE_LIST 1
739 #define USE_IMG_LST 1 or
740 #define _USE_IMAGE_LIST 1 or
741 #define USE_IMAGE_LIST_ 1 or
742 #define use_image_list 1 or
743 #define UseImageList 1
745 -------------------------------------------------------------------------------
749 6.4.1. Put braces on a line by themselves.
753 The brace needs to be on a line all by itself, not at the end of the statement.
754 Curly braces should line up with the construct that they're associated with.
755 This practice makes it easier to identify the opening and closing braces for a
767 if ( this == that ) { ... }
771 if ( this == that ) { ... }
773 Note: In the special case that the if-statement is inside a loop, and it is
774 trivial, i.e. it tests for a condition that is obvious from the purpose of the
775 block, one-liners as above may optically preserve the loop structure and make
778 Status: developer-discretion.
782 while ( more lines are read )
784 /* Please document what is/is not a comment line here */
785 if ( it's a comment ) continue;
787 do_something( line );
790 -------------------------------------------------------------------------------
792 6.4.2. ALL control statements should have a block
796 Using braces to make a block will make your code more readable and less prone
797 to error. All control statements should have a block defined.
809 if ( this == that ) DoSomething(); DoSomethingElse();
813 if ( this == that ) DoSomething();
815 Note: The first example in "Instead of" will execute in a manner other than
816 that which the developer desired (per indentation). Using code braces would
817 have prevented this "feature". The "explanation" and "exception" from the point
820 -------------------------------------------------------------------------------
822 6.4.3. Do not belabor/blow-up boolean expressions
826 structure->flag = ( condition );
830 if ( condition ) { structure->flag = 1; } else { structure->flag = 0; }
832 Note: The former is readable and concise. The later is wordy and inefficient.
833 Please assume that any developer new to the project has at least a "good"
834 knowledge of C/C++. (Hope I do not offend by that last comment ... 8-)
836 -------------------------------------------------------------------------------
838 6.4.4. Use white space freely because it is free
842 Make it readable. The notable exception to using white space freely is listed
843 in the next guideline.
849 int anotherValue = 0;
850 int thisVariable = 0;
852 if ( thisVariable == thatVariable )
854 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
856 -------------------------------------------------------------------------------
858 6.4.5. Don't use white space around structure operators
862 - structure pointer operator ( "->" ) - member operator ( "." ) - functions and
865 It is a general coding practice to put pointers, references, and function
866 parentheses next to names. With spaces, the connection between the object and
867 variable/function name is not as clear.
875 Instead of: aStruct -> aMember; aStruct . aMember; FunctionName ();
877 -------------------------------------------------------------------------------
879 6.4.6. Make the last brace of a function stand out
888 } /* -END- function1 */
893 } /* -END- function2 */
897 int function1( ... ) { ...code... return( retCode ); } int function2( ... ) { }
899 Note: Use 1 blank line before the closing brace and 2 lines afterward. This
900 makes the end of function standout to the most casual viewer. Although function
901 comments help separate functions, this is still a good coding practice. In
902 fact, I follow these rules when using blocks in "for", "while", "do" loops, and
903 long if {} statements too. After all whitespace is free!
905 Status: developer-discretion on the number of blank lines. Enforced is the end
906 of function comments.
908 -------------------------------------------------------------------------------
910 6.4.7. Use 3 character indentions
914 If some use 8 character TABs and some use 3 character TABs, the code can look *
915 very* ragged. So use 3 character indentions only. If you like to use TABs, pass
916 your code through a filter such as "expand -t3" before checking in your code.
920 static const char * const url_code_map[256] =
930 return( ALWAYS_TRUE );
934 return( HOW_DID_YOU_GET_HERE );
937 return( NEVER_GETS_HERE );
941 -------------------------------------------------------------------------------
945 6.5.1. Initialize all variables
949 Do not assume that the variables declared will not be used until after they
950 have been assigned a value somewhere else in the code. Remove the chance of
951 accidentally using an unassigned variable.
959 Note: It is much easier to debug a SIGSEGV if the message says you are trying
960 to access memory address 00000000 and not 129FA012; or arrayPtr[20] causes a
961 SIGSEV vs. arrayPtr[0].
963 Status: developer-discretion if and only if the variable is assigned a value
964 "shortly after" declaration.
966 -------------------------------------------------------------------------------
970 6.6.1. Name functions that return a boolean as a question.
974 Value should be phrased as a question that would logically be answered as a
975 true or false statement
983 -------------------------------------------------------------------------------
985 6.6.2. Always specify a return type for a function.
989 The default return for a function is an int. To avoid ambiguity, create a
990 return for a function when the return has a purpose, and create a void return
991 type if the function does not need to return anything.
993 -------------------------------------------------------------------------------
995 6.6.3. Minimize function calls when iterating by using variables
999 It is easy to write the following code, and a clear argument can be made that
1000 the code is easy to understand:
1004 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
1009 Note: Unfortunately, this makes a function call for each and every iteration.
1010 This increases the overhead in the program, because the compiler has to look up
1011 the function each time, call it, and return a value. Depending on what occurs
1012 in the blockListLength() call, it might even be creating and destroying
1013 structures with each iteration, even though in each case it is comparing "cnt"
1014 to the same value, over and over. Remember too - even a call to blockListLength
1015 () is a function call, with the same overhead.
1017 Instead of using a function call during the iterations, assign the value to a
1018 variable, and evaluate using the variable.
1022 size_t len = blockListLength();
1024 for ( size_t cnt = 0; cnt < len; cnt ++ )
1029 Exceptions: if the value of blockListLength() *may* change or could *
1030 potentially* change, then you must code the function call in the for/while
1033 -------------------------------------------------------------------------------
1035 6.6.4. Pass and Return by Const Reference
1039 This allows a developer to define a const pointer and call your function. If
1040 your function does not have the const keyword, we may not be able to use your
1041 function. Consider strcmp, if it were defined as: extern int strcmp( char *s1,
1044 I could then not use it to compare argv's in main: int main( int argc, const
1045 char *argv[] ) { strcmp( argv[0], "privoxy" ); }
1047 Both these pointers are *const*! If the c runtime library maintainers do it, we
1050 -------------------------------------------------------------------------------
1052 6.6.5. Pass and Return by Value
1056 Most structures cannot fit onto a normal stack entry (i.e. they are not 4 bytes
1057 or less). Aka, a function declaration like: int load_aclfile( struct
1060 would not work. So, to be consistent, we should declare all prototypes with
1061 "pass by value": int load_aclfile( struct client_state *csp )
1063 -------------------------------------------------------------------------------
1065 6.6.6. Names of include files
1069 Your include statements should contain the file name without a path. The path
1070 should be listed in the Makefile, using -I as processor directive to search the
1071 indicated paths. An exception to this would be for some proprietary software
1072 that utilizes a partial path to distinguish their header files from system or
1077 #include /* This is not a local include */
1078 #include "config.h" /* This IS a local include */
1082 /* This is not a local include, but requires a path element. */
1085 Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
1086 This duplicates the #include "file.h" behavior.
1088 -------------------------------------------------------------------------------
1090 6.6.7. Provide multiple inclusion protection
1094 Prevents compiler and linker errors resulting from redefinition of items.
1096 Wrap each header file with the following syntax to prevent multiple inclusions
1097 of the file. Of course, replace PROJECT_H with your file name, with "." Changed
1098 to "_", and make it uppercase.
1102 #ifndef PROJECT_H_INCLUDED
1103 #define PROJECT_H_INCLUDED
1105 #endif /* ndef PROJECT_H_INCLUDED */
1107 -------------------------------------------------------------------------------
1109 6.6.8. Use `extern "C"` when appropriate
1113 If our headers are included from C++, they must declare our functions as
1114 `extern "C"`. This has no cost in C, but increases the potential re-usability
1122 #endif /* def __cplusplus */
1124 ... function definitions here ...
1128 #endif /* def __cplusplus */
1130 -------------------------------------------------------------------------------
1132 6.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
1136 Useful in headers that include pointers to other struct's. Modifications to
1137 excess header files may cause needless compiles.
1141 /*********************************************************************
1142 * We're avoiding an include statement here!
1143 *********************************************************************/
1145 extern file_list *xyz;
1147 Note: If you declare "file_list xyz;" (without the pointer), then including the
1148 proper header file is necessary. If you only want to prototype a pointer,
1149 however, the header file is unnecessary.
1151 Status: Use with discretion.
1153 -------------------------------------------------------------------------------
1155 6.7. General Coding Practices
1157 6.7.1. Turn on warnings
1161 Compiler warnings are meant to help you find bugs. You should turn on as many
1162 as possible. With GCC, the switch is "-Wall". Try and fix as many warnings as
1165 -------------------------------------------------------------------------------
1167 6.7.2. Provide a default case for all switch statements
1171 What you think is guaranteed is never really guaranteed. The value that you
1172 don't think you need to check is the one that someday will be passed. So, to
1173 protect yourself from the unknown, always have a default step in a switch
1178 switch( hash_string( cmd ) )
1180 case hash_actions_file :
1190 ... anomaly code goes here ...
1191 continue; / break; / exit( 1 ); / etc ...
1193 } /* end switch( hash_string( cmd ) ) */
1195 Note: If you already have a default condition, you are obviously exempt from
1196 this point. Of note, most of the WIN32 code calls `DefWindowProc' after the
1197 switch statement. This API call *should* be included in a default statement.
1199 Another Note: This is not so much a readability issue as a robust programming
1200 issue. The "anomaly code goes here" may be no more than a print to the STDERR
1201 stream (as in load_config). Or it may really be an ABEND condition.
1203 Status: Programmer discretion is advised.
1205 -------------------------------------------------------------------------------
1207 6.7.3. Try to avoid falling through cases in a switch statement.
1211 In general, you will want to have a 'break' statement within each 'case' of a
1212 switch statement. This allows for the code to be more readable and
1213 understandable, and furthermore can prevent unwanted surprises if someone else
1214 later gets creative and moves the code around.
1216 The language allows you to plan the fall through from one case statement to
1217 another simply by omitting the break statement within the case statement. This
1218 feature does have benefits, but should only be used in rare cases. In general,
1219 use a break statement for each case statement.
1221 If you choose to allow fall through, you should comment both the fact of the
1222 fall through and reason why you felt it was necessary.
1224 -------------------------------------------------------------------------------
1226 6.7.4. Use 'long' or 'short' Instead of 'int'
1230 On 32-bit platforms, int usually has the range of long. On 16-bit platforms,
1231 int has the range of short.
1233 Status: open-to-debate. In the case of most FSF projects (including X/
1234 GNU-Emacs), there are typedefs to int4, int8, int16, (or equivalence ... I
1235 forget the exact typedefs now). Should we add these to IJB now that we have a
1238 -------------------------------------------------------------------------------
1240 6.7.5. Don't mix size_t and other types
1244 The type of size_t varies across platforms. Do not make assumptions about
1245 whether it is signed or unsigned, or about how long it is. Do not compare a
1246 size_t against another variable of a different type (or even against a
1247 constant) without casting one of the values. Try to avoid using size_t if you
1250 -------------------------------------------------------------------------------
1252 6.7.6. Declare each variable and struct on its own line.
1256 It can be tempting to declare a series of variables all on one line. Don't.
1268 Explanation: - there is more room for comments on the individual variables -
1269 easier to add new variables without messing up the original ones - when
1270 searching on a variable to find its type, there is less clutter to "visually"
1273 Exceptions: when you want to declare a bunch of loop variables or other trivial
1274 variables; feel free to declare them on 1 line. You should, although, provide a
1275 good comment on their functions.
1277 Status: developer-discretion.
1279 -------------------------------------------------------------------------------
1281 6.7.7. Use malloc/zalloc sparingly
1285 Create a local struct (on the stack) if the variable will live and die within
1286 the context of one function call.
1288 Only "malloc" a struct (on the heap) if the variable's life will extend beyond
1289 the context of one function call.
1293 If a function creates a struct and stores a pointer to it in a
1294 list, then it should definitely be allocated via `malloc'.
1296 -------------------------------------------------------------------------------
1298 6.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
1302 If you have to "malloc" an instance, you are responsible for insuring that the
1303 instance is `free'd, even if the deallocation event falls within some other
1304 programmer's code. You are also responsible for ensuring that deletion is
1305 timely (i.e. not too soon, not too late). This is known as "low-coupling" and
1306 is a "good thing (tm)". You may need to offer a free/unload/destuctor type
1307 function to accommodate this.
1311 int load_re_filterfile( struct client_state *csp ) { ... }
1312 static void unload_re_filterfile( void *f ) { ... }
1316 The developer cannot be expected to provide `free'ing functions for C run-time
1317 library functions ... such as `strdup'.
1319 Status: developer-discretion. The "main" use of this standard is for allocating
1320 and freeing data structures (complex or nested).
1322 -------------------------------------------------------------------------------
1324 6.7.9. Add loaders to the `file_list' structure and in order
1328 I have ordered all of the "blocker" file code to be in alpha order. It is
1329 easier to add/read new blockers when you expect a certain order.
1331 Note: It may appear that the alpha order is broken in places by POPUP tests
1332 coming before PCRS tests. But since POPUPs can also be referred to as
1333 KILLPOPUPs, it is clear that it should come first.
1335 -------------------------------------------------------------------------------
1337 6.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
1341 If you have enough confidence in new code or confidence in your changes, but
1342 are not *quite* sure of the repercussions, add this:
1344 /* FIXME: this code has a logic error on platform XYZ, * attempting to fix */ #
1345 ifdef PLATFORM ...changed code here... #endif
1349 /* FIXME: I think the original author really meant this... */ ...changed code
1354 /* FIXME: new code that *may* break something else... */ ...new code here...
1356 Note: If you make it clear that this may or may not be a "good thing (tm)", it
1357 will be easier to identify and include in the project (or conversely exclude
1360 -------------------------------------------------------------------------------
1362 6.8. Addendum: Template for files and function comment blocks:
1364 Example for file comments:
1366 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.35 2002/04/17 15:16:15 oes Exp $";
1367 /*********************************************************************
1371 * Purpose : (Fill me in with a good description!)
1373 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1374 * Privoxy team. http://www.privoxy.org/
1376 * Based on the Internet Junkbuster originally written
1377 * by and Copyright (C) 1997 Anonymous Coders and
1378 * Junkbusters Corporation. http://www.junkbusters.com
1380 * This program is free software; you can redistribute it
1381 * and/or modify it under the terms of the GNU General
1382 * Public License as published by the Free Software
1383 * Foundation; either version 2 of the License, or (at
1384 * your option) any later version.
1386 * This program is distributed in the hope that it will
1387 * be useful, but WITHOUT ANY WARRANTY; without even the
1388 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1389 * PARTICULAR PURPOSE. See the GNU General Public
1390 * License for more details.
1392 * The GNU General Public License should be included with
1393 * this file. If not, you can view it at
1394 * http://www.gnu.org/copyleft/gpl.html
1395 * or write to the Free Software Foundation, Inc., 59
1396 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1401 *********************************************************************/
1406 ...necessary include files for us to do our work...
1408 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1410 Note: This declares the rcs variables that should be added to the
1411 "show-proxy-args" page. If this is a brand new creation by you, you are free to
1412 change the "Copyright" section to represent the rights you wish to maintain.
1414 Note: The formfeed character that is present right after the comment flower box
1415 is handy for (X|GNU)Emacs users to skip the verbiage and get to the heart of
1416 the code (via `forward-page' and `backward-page'). Please include it if you
1419 Example for file header comments:
1423 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.35 2002/04/17 15:16:15 oes Exp $"
1424 /*********************************************************************
1428 * Purpose : (Fill me in with a good description!)
1430 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1431 * Privoxy team. http://www.privoxy.org/
1433 * Based on the Internet Junkbuster originally written
1434 * by and Copyright (C) 1997 Anonymous Coders and
1435 * Junkbusters Corporation. http://www.junkbusters.com
1437 * This program is free software; you can redistribute it
1438 * and/or modify it under the terms of the GNU General
1439 * Public License as published by the Free Software
1440 * Foundation; either version 2 of the License, or (at
1441 * your option) any later version.
1443 * This program is distributed in the hope that it will
1444 * be useful, but WITHOUT ANY WARRANTY; without even the
1445 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1446 * PARTICULAR PURPOSE. See the GNU General Public
1447 * License for more details.
1449 * The GNU General Public License should be included with
1450 * this file. If not, you can view it at
1451 * http://www.gnu.org/copyleft/gpl.html
1452 * or write to the Free Software Foundation, Inc., 59
1453 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1458 *********************************************************************/
1461 #include "project.h"
1467 ... function headers here ...
1470 /* Revision control strings from this header and associated .c file */
1471 extern const char FILENAME_rcs[];
1472 extern const char FILENAME_h_rcs[];
1479 #endif /* ndef _FILENAME_H */
1487 Example for function comments:
1489 /*********************************************************************
1491 * Function : FUNCTION_NAME
1493 * Description : (Fill me in with a good description!)
1496 * 1 : param1 = pointer to an important thing
1497 * 2 : x = pointer to something else
1499 * Returns : 0 => Ok, everything else is an error.
1501 *********************************************************************/
1502 int FUNCTION_NAME( void *param1, const char *x )
1509 Note: If we all follow this practice, we should be able to parse our code to
1510 create a "self-documenting" web page.
1512 -------------------------------------------------------------------------------
1514 7. Testing Guidelines
1518 -------------------------------------------------------------------------------
1520 7.1. Testplan for releases
1522 Explain release numbers. major, minor. developer releases. etc.
1524 1. Remove any existing rpm with rpm -e
1526 2. Remove any file that was left over. This includes (but is not limited to)
1534 + /etc/init.d/privoxy
1538 3. Install the rpm. Any error messages?
1540 4. start,stop,status Privoxy with the specific script (e.g. /etc/rc.d/init/
1541 privoxy stop). Reboot your machine. Does autostart work?
1543 5. Start browsing. Does Privoxy work? Logfile written?
1545 6. Remove the rpm. Any error messages? All files removed?
1547 -------------------------------------------------------------------------------
1551 Please submit test reports only with the test form at sourceforge. Three simple
1554 * Select category: the distribution you test on.
1556 * Select group: the version of Privoxy that we are about to release.
1558 * Fill the Summary and Detailed Description with something intelligent (keep
1559 it short and precise).
1561 Do not mail to the mailinglist (we cannot keep track on issues there).
1563 -------------------------------------------------------------------------------
1565 8. Releasing a New Version
1567 When we release versions of Privoxy, our work leaves our cozy secret lab and
1568 has to work in the cold RealWorld[tm]. Once it is released, there is no way to
1569 call it back, so it is very important that great care is taken to ensure that
1570 everything runs fine, and not to introduce problems in the very last minute.
1572 So when releasing a new version, please adhere exactly to the procedure
1573 outlined in this chapter.
1575 The following programs are required to follow this process: ncftpput (ncftp),
1576 scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs.
1578 In the following text, replace X, Y and Z with the actual version number (X =
1579 major, Y = minor, Z = point):
1581 -------------------------------------------------------------------------------
1583 8.1. Before the Release
1585 The following must be done by one of the developers prior to each new release.
1587 * Make sure that everybody who has worked on the code in the last couple of
1588 days has had a chance to yell "no!" in case they have pending changes/fixes
1591 * Increment the version number and increase or reset the RPM release number
1592 in configure.in as appropriate.
1594 * If the default actionsfile has changed since last release, bump up its
1595 version info in this line:
1597 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
1600 Then change the version info in doc/webserver/actions/index.php, line:
1601 '$required_actions_file_version = "A.B";'
1603 * If the HTML documentation is not in sync with the SGML sources you need to
1604 regenerate it. (If in doubt, just do it.) See the Section "Updating the
1605 webserver" in this manual for details.
1607 * Commit all files that were changed in the above steps!
1609 * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
1610 use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
1612 -------------------------------------------------------------------------------
1614 8.2. Building and Releasing the Packages
1616 Now the individual packages can be built and released. Note that for GPL
1617 reasons the first package to be released is always the source tarball.
1619 For all types of packages, including the source tarball, you must make sure
1620 that you build from clean sources by exporting the right version from CVS into
1621 an empty directory:.
1623 mkdir dist # delete or choose different name if it already exists
1625 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1626 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1629 Do NOT change a single bit, including, but not limited to version information
1630 after export from CVS. This is to make sure that all release packages, and with
1631 them, all future bug reports, are based on exactly the same code.
1633 Please find additional instructions for the source tarball and the individual
1634 platform dependent binary packages below.
1636 -------------------------------------------------------------------------------
1638 8.2.1. Source Tarball
1640 First, make sure that you have freshly exported the right version into an empty
1641 directory. (See "Building and releasing packages" above). Then run:
1644 autoheader && autoconf && ./configure
1652 To upload the package to Sourceforge, simply issue
1657 Go to the displayed URL and release the file publicly on Sourceforge. For the
1658 change log field, use the relevant section of the ChangeLog file.
1660 -------------------------------------------------------------------------------
1662 8.2.2. SuSE or Red Hat
1664 First, make sure that you have freshly exported the right version into an empty
1665 directory. (See "Building and releasing packages" above). Then run:
1668 autoheader && autoconf && ./configure
1673 make suse-dist (or make redhat-dist)
1676 To upload the package to Sourceforge, simply issue
1678 make suse-upload (or make redhat-upload)
1681 Go to the displayed URL and release the file publicly on Sourceforge. Use the
1682 release notes and çhange log from the source tarball package.
1684 -------------------------------------------------------------------------------
1688 First, make sure that you have freshly exported the right version into an empty
1689 directory. (See "Building and releasing packages" above). Then get the OS/2
1692 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
1695 You will need a mix of development tools. The main compilation takes place with
1696 IBM Visual Age C++. Some ancillary work takes place with GNU tools, available
1697 from various sources like hobbes.nmsu.edu. Specificially, you will need
1698 autoheader, autoconf and sh tools. The packaging takes place with WarpIN,
1699 available from various sources, including its home page: xworkplace.
1701 Change directory to the os2setup directory. Edit the os2build.cmd file to set
1702 the final executable filename. For example,
1704 installExeName='privoxyos2_setup_X.Y.Z.exe'
1707 Next, edit the IJB.wis file so the release number matches in the PACKAGEID
1710 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
1713 You're now ready to build. Run:
1718 You will find the WarpIN-installable executable in the ./files directory.
1719 Upload this anonymously to uploads.sourceforge.net/incoming, create a release
1720 for it, and you're done. Use the release notes and Change Log from the source
1723 -------------------------------------------------------------------------------
1727 Login to Sourceforge's compilefarm via ssh:
1729 ssh cf.sourceforge.net
1732 Choose the right operating system (not the Debian one). When logged in, make
1733 sure that you have freshly exported the right version into an empty directory.
1734 (See "Building and releasing packages" above). Then run:
1737 autoheader && autoconf && ./configure
1745 which creates a gzip'ed tar archive. Sadly, you cannot use make solaris-upload
1746 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1747 archive to Sourceforge's ftp server and release the file publicly. Use the
1748 release notes and Change Log from the source tarball package.
1750 -------------------------------------------------------------------------------
1754 You should ensure you have the latest version of Cygwin (from http://
1755 www.cygwin.com/). Run the following commands from within a Cygwin bash shell.
1757 First, make sure that you have freshly exported the right version into an empty
1758 directory. (See "Building and releasing packages" above). Then get the Windows
1761 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
1764 Then you can build the package. This is fully automated, and is controlled by
1765 winsetup/GNUmakefile. All you need to do is:
1771 Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
1772 upload it to SourceForge. When releasing the package on SourceForge, use the
1773 release notes and Change Log from the source tarball package.
1775 -------------------------------------------------------------------------------
1779 First, make sure that you have freshly exported the right version into an empty
1780 directory. (See "Building and releasing packages" above). Then, run:
1783 autoheader && autoconf && ./configure
1788 -------------------------------------------------------------------------------
1792 First, make sure that you have freshly exported the right version into an empty
1793 directory. (See "Building and releasing packages" above). Then get the Mac OSX
1796 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
1805 This will run autoheader, autoconf and configure as well as make. Finally, it
1806 will copy over the necessary files to the ./osxsetup/files directory for
1807 further processing by PackageMaker.
1809 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the
1810 package name to match the release, and hit the "Create package" button. If you
1811 specify ./Privoxy.pkg as the output package name, you can then create the
1812 distributable zip file with the command:
1814 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
1817 You can then upload privoxyosx_setup_x.y.z.zip anonymously to
1818 uploads.sourceforge.net/incoming, create a release for it, and you're done. Use
1819 the release notes and Change Log from the source tarball package.
1821 -------------------------------------------------------------------------------
1825 Login to Sourceforge's compilefarm via ssh:
1827 ssh cf.sourceforge.net
1830 Choose the right operating system. When logged in, make sure that you have
1831 freshly exported the right version into an empty directory. (See "Building and
1832 releasing packages" above). Then run:
1835 autoheader && autoconf && ./configure
1843 which creates a gzip'ed tar archive. Sadly, you cannot use make freebsd-upload
1844 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1845 archive to Sourceforge's ftp server and release the file publicly. Use the
1846 release notes and Change Log from the source tarball package.
1848 -------------------------------------------------------------------------------
1852 First, make sure that you have freshly exported the right version into an empty
1853 directory. (See "Building and releasing packages" above). Then run:
1856 autoheader && autoconf && ./configure
1861 -------------------------------------------------------------------------------
1865 First, make sure that you have freshly exported the right version into an empty
1866 directory. (See "Building and releasing packages" above). Then run:
1869 autoheader && autoconf && ./configure
1874 -------------------------------------------------------------------------------
1878 Login to Sourceforge's compilefarm via ssh:
1880 ssh cf.sourceforge.net
1883 Choose the right operating system. When logged in, make sure that you have
1884 freshly exported the right version into an empty directory. (See "Building and
1885 releasing packages" above). Then run:
1888 autoheader && autoconf && ./configure
1896 which creates a gzip'ed tar archive. Sadly, you cannot use make aix-upload on
1897 the Sourceforge machine (no ncftpput). You now have to manually upload the
1898 archive to Sourceforge's ftp server and release the file publicly. Use the
1899 release notes and Change Log from the source tarball package.
1901 -------------------------------------------------------------------------------
1903 8.3. After the Release
1905 When all (or: most of the) packages have been uploaded and made available, send
1906 an email to the announce mailing list, Subject: "Version X.Y.Z available for
1907 download". Be sure to include the download location, the release notes and the
1910 -------------------------------------------------------------------------------
1912 9. Update the Webserver
1914 When updating the webserver, please follow these steps to make sure that no
1915 broken links, incosistent contents or permission problems will occur:
1917 If you have changed anything in the documentation source SGML files, do:
1919 make dok # (or make redkat-dok if make dok doesn't work for you)
1922 That will generate doc/webserver/user-manual, doc/webserver/developer-manual,
1923 doc/webserver/faq and doc/webserver/index.html automatically.
1925 If you changed the manual page source, generate doc/webserver/man-page/
1926 privoxy-man-page.html by running "make man". (This is a separate target due to
1927 dependencies on some obscure perl scripts. See comments in GNUmakefile.)
1929 If you want to add new files to the webserver, create them locally in the doc/
1930 webserver/* directory (or create new directories under doc/webserver).
1932 Next, commit any changes from the above steps to CVS. All set? Then do
1937 This will do the upload to the webserver (www.privoxy.org) and ensure all files
1938 and directories there are group writable.
1940 Please do NOT use any other means of transferring files to the webserver to
1941 avoid permission problems.
1943 -------------------------------------------------------------------------------
1945 10. Contacting the developers, Bug Reporting and Feature Requests
1947 We value your feedback. However, to provide you with the best support, please
1950 * Use the Sourceforge Support Forum to get help:
1952 http://sourceforge.net/tracker/?group_id=11118&atid=211118
1955 * Submit bugs only through our Sourceforge Bug Forum:
1957 http://sourceforge.net/tracker/?group_id=11118&atid=111118.
1960 Make sure that the bug has not already been submitted. Please try to verify
1961 that it is a Privoxy bug, and not a browser or site bug first. If you are
1962 using your own custom configuration, please try the stock configs to see if
1963 the problem is a configuration related bug. And if not using the latest
1964 development snapshot, please try the latest one. Or even better, CVS
1965 sources. Please be sure to include the Privoxy/Junkbuster version,
1966 platform, browser, any pertinent log data, any other relevant details
1967 (please be specific) and, if possible, some way to reproduce the bug.
1969 * Submit feature requests only through our Sourceforge feature request forum:
1971 http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
1974 * You can also send feedback on websites that Privoxy has problems with. Please bookmark
1975 the following link: "Privoxy - Submit Filter Feedback"
1976 . Once you surf to a page with problems, use the
1977 bookmark to send us feedback. We will look into the issue as soon as possible.
1980 * For any other issues, feel free to use the mailing lists:
1982 http://sourceforge.net/mail/?group_id=11118.
1985 Anyone interested in actively participating in development and related
1986 discussions can also join the appropriate mailing list. Archives are
1989 -------------------------------------------------------------------------------
1991 11. Copyright and History
1995 Privoxy is free software; you can redistribute it and/or modify it under the
1996 terms of the GNU General Public License as published by the Free Software
1997 Foundation; either version 2 of the License, or (at your option) any later
2000 This program is distributed in the hope that it will be useful, but WITHOUT ANY
2001 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
2002 PARTICULAR PURPOSE. See the GNU General Public License for more details, which
2003 is available from the Free Software Foundation, Inc, 59 Temple Place - Suite
2004 330, Boston, MA 02111-1307, USA.
2006 You should have received a copy of the GNU General Public License along with
2007 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
2008 Place, Suite 330, Boston, MA 02111-1307 USA.
2010 -------------------------------------------------------------------------------
2014 Privoxy is evolved, and derived from, the Internet Junkbuster, with many
2015 improvments and enhancements over the original.
2017 Junkbuster was originally written by Anonymous Coders and Junkbusters
2018 Corporation, and was released as free open-source software under the GNU GPL.
2019 Stefan Waldherr made many improvements, and started the SourceForge project
2020 Privoxy to rekindle development. There are now several active developers
2021 contributing. The last stable release of Junkbuster was v2.0.2, which has now
2024 -------------------------------------------------------------------------------
2028 Other references and sites of interest to Privoxy users:
2030 http://www.privoxy.org/, The Privoxy Home page.
2032 http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on
2035 http://p.p/, access Privoxy from your browser. Alternately, http://
2036 config.privoxy.org may work in some situations where the first does not.
2038 http://p.p/, and select "actions file feedback system" to submit "misses" to
2041 http://www.junkbusters.com/ht/en/cookies.html
2043 http://www.waldherr.org/junkbuster/
2045 http://privacy.net/analyze/
2047 http://www.squid-cache.org/