1 Privoxy Developer Manual
3 Copyright © 2001, 2002 by Privoxy Developers
5 $Id: developer-manual.sgml,v 1.46.2.6 2002/08/10 11:40:25 oes Exp $
8 The developer manual provides guidance on coding, testing, packaging,
9 documentation and other issues of importance to those involved with Privoxy
10 development. It is mandatory (and helpful!) reading for anyone who wants to
13 Please note that this document is constantly evolving. This copy represents the
14 state at the release of version 2.9.20. You can find the latest version of the
15 this manual at http://www.privoxy.org/developer-manual/. Please see the Contact
16 section on how to contact the developers.
18 -------------------------------------------------------------------------------
21 1.1. Quickstart to Privoxy Development
26 2.2. CVS Commit Guideline
27 2.3. Discussing Changes First
30 3. Documentation Guidelines
31 3.1. Quickstart to Docbook and SGML
32 3.2. Privoxy Documentation Style
33 3.3. Privoxy Custom Entities
39 4.2.1. Comment, Comment, Comment
40 4.2.2. Use blocks for comments
41 4.2.3. Keep Comments on their own line
42 4.2.4. Comment each logical step
43 4.2.5. Comment All Functions Thoroughly
44 4.2.6. Comment at the end of braces if the content is more than one
48 4.3. Naming Conventions
51 4.3.3. Header file prototypes
52 4.3.4. Enumerations, and #defines
57 4.4.1. Put braces on a line by themselves.
58 4.4.2. ALL control statements should have a block
59 4.4.3. Do not belabor/blow-up boolean expressions
60 4.4.4. Use white space freely because it is free
61 4.4.5. Don't use white space around structure operators
62 4.4.6. Make the last brace of a function stand out
63 4.4.7. Use 3 character indentions
67 4.5.1. Initialize all variables
71 4.6.1. Name functions that return a boolean as a question.
72 4.6.2. Always specify a return type for a function.
73 4.6.3. Minimize function calls when iterating by using variables
74 4.6.4. Pass and Return by Const Reference
75 4.6.5. Pass and Return by Value
76 4.6.6. Names of include files
77 4.6.7. Provide multiple inclusion protection
78 4.6.8. Use `extern "C"` when appropriate
79 4.6.9. Where Possible, Use Forward Struct Declaration Instead of
83 4.7. General Coding Practices
84 4.7.1. Turn on warnings
85 4.7.2. Provide a default case for all switch statements
86 4.7.3. Try to avoid falling through cases in a switch statement.
87 4.7.4. Use 'long' or 'short' Instead of 'int'
88 4.7.5. Don't mix size_t and other types
89 4.7.6. Declare each variable and struct on its own line.
90 4.7.7. Use malloc/zalloc sparingly
91 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
93 4.7.9. Add loaders to the `file_list' structure and in order
94 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
97 4.8. Addendum: Template for files and function comment blocks:
100 5. Testing Guidelines
101 5.1. Testplan for releases
105 6. Releasing a New Version
107 6.2. Before the Release: Freeze
108 6.3. Building and Releasing the Packages
109 6.3.1. Note on Privoxy Packaging
110 6.3.2. Source Tarball
111 6.3.3. SuSE, Conectiva or Red Hat RPM
123 6.4. Uploading and Releasing Your Package
124 6.5. After the Release
127 7. Update the Webserver
128 8. Contacting the developers, Bug Reporting and Feature Requests
131 8.3. Request New Features
132 8.4. Report Ads or Other Actions-Related Problems
136 9. Privoxy Copyright, License and History
145 Privoxy, as an heir to Junkbuster, is an Open Source project and licensed under
146 the GPL. As such, Privoxy development is potentially open to anyone who has the
147 time, knowledge, and desire to contribute in any capacity. Our goals are simply
148 to continue the mission, to improve Privoxy, and to make it available to as
149 wide an audience as possible.
151 One does not have to be a programmer to contribute. Packaging, testing, and
152 porting, are all important jobs as well.
153 -------------------------------------------------------------------------------
155 1.1. Quickstart to Privoxy Development
157 You'll need an account on Sourceforge to support our development. Mail your ID
158 to the list and wait until a project manager has added you.
160 For the time being (read, this section is under construction), please refer to
161 the extensive comments in the source code.
162 -------------------------------------------------------------------------------
164 2. The CVS Repository
166 If you intend to help us with programming, documentation or packaging you will
167 need write access to our holy grail, the CVS repository. Please read this
168 chapter completely before accessing via CVS.
169 -------------------------------------------------------------------------------
173 The project's CVS repository is hosted on SourceForge. Please refer to the
174 chapters 6 and 7 in SF's site documentation for the technical access details
175 for your operating system. For historical reasons, the CVS server is called
176 cvs.ijbswa.sourceforge.net, the repository is called ijbswa, and the source
177 tree module is called current.
178 -------------------------------------------------------------------------------
180 2.2. CVS Commit Guideline
182 The source tree is the heart of every software project. Every effort must be
183 made to ensure that it is readable, compilable and consistent at all times. We
184 therefore ask anyone with CVS access to strictly adhere to the following
187 * Never (read: never, ever) be tempted to commit that small change without
188 testing it thoroughly first. When we're close to a public release, ask a
189 fellow developer to review your changes.
191 * Your commit message should give a concise overview of what you changed (no
192 big details) and why you changed it Just check previous messages for good
195 * Don't use the same message on multiple files, unless it equally applies to
198 * If your changes span multiple files, and the code won't recompile unless
199 all changes are committed (e.g. when changing the signature of a function),
200 then commit all files one after another, without long delays in between. If
201 necessary, prepare the commit messages in advance.
203 * Before changing things on CVS, make sure that your changes are in line with
204 the team's general consensus on what should be done (see below).
206 * Don't commit into the stable branch, unless immediately before a new
207 release. (See Version Numbers below for details.) Collect your changes on
208 the patches tracker instead.
211 -------------------------------------------------------------------------------
212 2.3. Discussing Changes First
214 We don't have a too formal policy on this, just use common sense. Hints: If it
217 1. ..a bug-fix / clean-up / cosmetic thing: shoot
219 2. ..a new feature that can be turned off: shoot
221 3. ..a clear improvement w/o side effects on other parts of the code: shoot
223 4. ..a matter of taste: ask the list
225 5. ..a major redesign of some part of the code: ask the list
228 Note that near a major public release, we get a bit more cautious - if unsure,
229 it doesn't hurt to ask first. There is always the possibility to submit a patch
230 to the patches tracker instead.
231 -------------------------------------------------------------------------------
233 3. Documentation Guidelines
235 All formal documents are maintained in Docbook SGML and located in the doc/
236 source/* directory. You will need Docbook, the Docbook DTD's and the Docbook
237 modular stylesheets (or comparable alternatives), and either jade or openjade
238 (recommended) installed in order to build docs from source. Currently there is
239 user-manual, FAQ, and, of course this, the developer-manual in this format. The
240 README, AUTHORS privoxy.1 (man page), and config files are also now maintained
241 as Docbook SGML. These files, when built, in the top-level source directory are
242 generated files! Also, the Privoxy index.html (and a variation on this file,
243 privoxy-index.html, meant for inclusion with doc packages), are maintained as
244 SGML as well. DO NOT edit these directly. Edit the SGML source, or contact
245 someone involved in the documentation (at present Stefan and Hal).
247 config requires some special handling. The reason it is maintained this way is
248 so that the extensive comments in the file mirror those in user-manual. But the
249 conversion process requires going from SGML to HTML to text to special
250 formatting required for the embedded comments. Some of this does not survive so
251 well. Especially some of the examples that are longer than 80 characters. The
252 build process for this file outputs to config.new, which should be reviewed for
253 errors and mis-formatting. Once satisfied that it is correct, then it should be
254 hand copied to config.
256 Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain
257 text files in the top-level source directory. At least for the time being.
259 Packagers are encouraged to include this documentation. For those without the
260 ability to build the docs locally, text versions of each are kept in CVS. HTML
261 versions are also now being kept in CVS under doc/webserver/*.
263 Formal documents are built with the Makefile targets of make dok, or
264 alternately make redhat-dok. If you have problems, try both. The build process
265 uses the document SGML sources in doc/source/*/* to update all text files in
266 doc/text/ and to update all HTML documents in doc/webserver/.
268 Documentation writers should please make sure documents build successfully
269 before committing to CVS, if possible.
271 How do you update the webserver (i.e. the pages on privoxy.org)?
273 1. First, build the docs by running make dok (or alternately make redhat-dok).
275 2. Run make webserver which copies all files from doc/webserver to the
276 sourceforge webserver via scp.
279 Finished docs should be occasionally submitted to CVS (doc/webserver/*/*.html)
280 so that those without the ability to build them locally, have access to them if
281 needed. This is especially important just prior to a new release! Please do
282 this after the $VERSION and other release specific data in configure.in has
283 been updated (this is done just prior to a new release).
284 -------------------------------------------------------------------------------
286 3.1. Quickstart to Docbook and SGML
288 If you are not familiar with SGML, it is a markup language similar to HTML.
289 Actually, not a mark up language per se, but a language used to define markup
290 languages. In fact, HTML is an SGML application. Both will use "tags" to format
291 text and other content. SGML tags can be much more varied, and flexible, but do
292 much of the same kinds of things. The tags, or "elements", are definable in
293 SGML. There is no set "standards". Since we are using Docbook, our tags are
294 those that are defined by Docbook. Much of how the finish document is rendered
295 is determined by the "stylesheets". The stylesheets determine how each tag gets
296 translated to HTML, or other formats.
298 Tags in Docbook SGML need to be always "closed". If not, you will likely
299 generate errors. Example: <title>My Title</title>. They are also
300 case-insensitive, but we strongly suggest using all lower case. This keeps
301 compatibility with [Docbook] XML.
303 Our documents use "sections" for the most part. Sections will be processed into
304 HTML headers (e.g. h1 for sect1). The Docbook stylesheets will use these to
305 also generate the Table of Contents for each doc. Our TOC's are set to a depth
306 of three. Meaning sect1, sect2, and sect3 will have TOC entries, but sect4 will
307 not. Each section requires a <title> element, and at least one <para>. There is
308 a limit of five section levels in Docbook, but generally three should be
309 sufficient for our purposes.
311 Some common elements that you likely will use:
313 <para></para>, paragraph delimiter. Most text needs to be within paragraph
314 elements (there are some exceptions).
315 <emphasis></emphasis>, the stylesheets make this italics.
316 <filename></filename>, files and directories.
317 <command></command>, command examples.
318 <literallayout></literallayout>, like <pre>, more or less.
319 <itemizedlist></itemizedlist>, list with bullets.
320 <listitem></listitem>, member of the above.
321 <screen></screen>, screen output, implies <literallayout>.
322 <ulink url="example.com"></ulink>, like HTML <a> tag.
323 <quote></quote>, for, doh, quoting text.
325 Look at any of the existing docs for examples of all these and more.
327 You might also find "Writing Documentation Using DocBook - A Crash Course"
329 -------------------------------------------------------------------------------
331 3.2. Privoxy Documentation Style
333 It will be easier if everyone follows a similar writing style. This just makes
334 it easier to read what someone else has written if it is all done in a similar
339 * All tags should be lower case.
341 * Tags delimiting a block of text (even small blocks) should be on their own
348 Tags marking individual words, or few words, should be in-line:
350 Just to <emphasis>emphasize</emphasis>, some text goes here.
353 * Tags should be nested and step indented for block text like: (except
360 Some text goes here in our list example.
366 This makes it easier to find the text amongst the tags ;-)
367 * Use white space to separate logical divisions within a document, like
368 between sections. Running everything together consistently makes it harder
371 * Do not hesitate to make comments. Comments can either use the <comment>
372 element, or the <!-- --> style comment familiar from HTML. (Note in Docbook
373 v4.x <comment> is replaced by <remark>.)
375 * We have an international audience. Refrain from slang, or English
376 idiosyncrasies (too many to list :). Humor also does not translate well
379 * Try to keep overall line lengths in source files to 80 characters or less
380 for obvious reasons. This is not always possible, with lengthy URLs for
383 * Our documents are available in differing formats. Right now, they are just
384 plain text, and HTML, but PDF, and others is always a future possibility.
385 Be careful with URLs (<ulink>), and avoid this mistake:
387 My favorite site is <ulink url="http://example.com">here</ulink>.
389 This will render as "My favorite site is here", which is not real helpful
390 in a text doc. Better like this:
392 My favorite site is <ulink url="http://example.com">example.com</ulink>.
394 * All documents should be spell checked occasionally. aspell can check SGML
395 with the -H option. (ispell I think too.)
398 -------------------------------------------------------------------------------
399 3.3. Privoxy Custom Entities
401 Privoxy documentation is using a number of customized "entities" to facilitate
402 documentation maintenance.
404 We are using a set of "boilerplate" files with generic text, that is used by
405 multiple docs. This way we can write something once, and use it repeatedly
406 without having to re-write the same content over and over again. If editing
407 such a file, keep in mind that it should be generic. That is the purpose; so it
408 can be used in varying contexts without additional modifications.
410 We are also using what Docbook calls "internal entities". These are like
411 variables in programming. Well, sort of. For instance, we have the p-version
412 entity that contains the current Privoxy version string. You are strongly
413 encouraged to use these where possible. Some of these obviously require
414 re-setting with each release (done by the Makefile). A sampling of custom
415 entities are listed below. See any of the main docs for examples.
417 * Re- "boilerplate" text entities are defined like:
419 <!entity supported SYSTEM "supported.sgml">
421 In this example, the contents of the file, supported.sgml is available for
422 inclusion anywhere in the doc. To make this happen, just reference the now
423 defined entity: &supported; (starts with an ampersand and ends with a
424 semi-colon), and the contents will be dumped into the finished doc at that
427 * Commonly used "internal entities":
429 p-version: the Privoxy version string, e.g. "2.9.20".
430 p-status: the project status, either "alpha", "beta", or "stable".
431 p-not-stable: use to conditionally include text in "not stable" releases
433 p-stable: just the opposite.
434 p-text: this doc is only generated as text.
438 There are others in various places that are defined for a specific purpose.
440 -------------------------------------------------------------------------------
446 This set of standards is designed to make our lives easier. It is developed
447 with the simple goal of helping us keep the "new and improved Privoxy"
448 consistent and reliable. Thus making maintenance easier and increasing chances
449 of success of the project.
451 And that of course comes back to us as individuals. If we can increase our
452 development and product efficiencies then we can solve more of the request for
453 changes/improvements and in general feel good about ourselves. ;->
454 -------------------------------------------------------------------------------
458 4.2.1. Comment, Comment, Comment
462 Comment as much as possible without commenting the obvious. For example do not
463 comment "aVariable is equal to bVariable". Instead explain why aVariable should
464 be equal to the bVariable. Just because a person can read code does not mean
465 they will understand why or what is being done. A reader may spend a lot more
466 time figuring out what is going on when a simple comment or explanation would
467 have prevented the extra research. Please help your brother IJB'ers out!
469 The comments will also help justify the intent of the code. If the comment
470 describes something different than what the code is doing then maybe a
471 programming error is occurring.
474 /* if page size greater than 1k ... */
475 if ( PageLength() > 1024 )
477 ... "block" the page up ...
480 /* if page size is small, send it in blocks */
481 if ( PageLength() > 1024 )
483 ... "block" the page up ...
486 This demonstrates 2 cases of "what not to do". The first is a
487 "syntax comment". The second is a comment that does not fit what
488 is actually being done.
489 -------------------------------------------------------------------------------
491 4.2.2. Use blocks for comments
495 Comments can help or they can clutter. They help when they are differentiated
496 from the code they describe. One line comments do not offer effective
497 separation between the comment and the code. Block identifiers do, by
498 surrounding the code with a clear, definable pattern.
501 /*********************************************************************
502 * This will stand out clearly in your code!
503 *********************************************************************/
504 if ( thisVariable == thatVariable )
506 DoSomethingVeryImportant();
510 /* unfortunately, this may not */
511 if ( thisVariable == thatVariable )
513 DoSomethingVeryImportant();
517 if ( thisVariable == thatVariable ) /* this may not either */
519 DoSomethingVeryImportant();
524 If you are trying to add a small logic comment and do not wish to "disrupt" the
525 flow of the code, feel free to use a 1 line comment which is NOT on the same
527 -------------------------------------------------------------------------------
529 4.2.3. Keep Comments on their own line
533 It goes back to the question of readability. If the comment is on the same line
534 as the code it will be harder to read than the comment that is on its own line.
536 There are three exceptions to this rule, which should be violated freely and
537 often: during the definition of variables, at the end of closing braces, when
538 used to comment parameters.
541 /*********************************************************************
542 * This will stand out clearly in your code,
543 * But the second example won't.
544 *********************************************************************/
545 if ( thisVariable == thatVariable )
547 DoSomethingVeryImportant();
550 if ( thisVariable == thatVariable ) /*can you see me?*/
552 DoSomethingVeryImportant(); /*not easily*/
556 /*********************************************************************
557 * But, the encouraged exceptions:
558 *********************************************************************/
559 int urls_read = 0; /* # of urls read + rejected */
560 int urls_rejected = 0; /* # of urls rejected */
564 DoSomethingVeryImportant();
568 short DoSomethingVeryImportant(
569 short firstparam, /* represents something */
570 short nextparam /* represents something else */ )
574 } /* -END- DoSomethingVeryImportant */
575 -------------------------------------------------------------------------------
577 4.2.4. Comment each logical step
581 Logical steps should be commented to help others follow the intent of the
582 written code and comments will make the code more readable.
584 If you have 25 lines of code without a comment, you should probably go back
585 into it to see where you forgot to put one.
587 Most "for", "while", "do", etc... loops _probably_ need a comment. After all,
588 these are usually major logic containers.
589 -------------------------------------------------------------------------------
591 4.2.5. Comment All Functions Thoroughly
595 A reader of the code should be able to look at the comments just prior to the
596 beginning of a function and discern the reason for its existence and the
597 consequences of using it. The reader should not have to read through the code
598 to determine if a given function is safe for a desired use. The proper
599 information thoroughly presented at the introduction of a function not only
600 saves time for subsequent maintenance or debugging, it more importantly aids in
601 code reuse by allowing a user to determine the safety and applicability of any
602 function for the problem at hand. As a result of such benefits, all functions
603 should contain the information presented in the addendum section of this
605 -------------------------------------------------------------------------------
607 4.2.6. Comment at the end of braces if the content is more than one screen
612 Each closing brace should be followed on the same line by a comment that
613 describes the origination of the brace if the original brace is off of the
614 screen, or otherwise far away from the closing brace. This will simplify the
615 debugging, maintenance, and readability of the code.
617 As a suggestion , use the following flags to make the comment and its brace
620 use following a closing brace: } /* -END- if() or while () or etc... */
625 DoSomethingVeryImportant();
626 ...some long list of commands...
627 } /* -END- if x is 1 */
633 DoSomethingVeryImportant();
634 ...some long list of commands...
635 } /* -END- if ( 1 == X ) */
636 -------------------------------------------------------------------------------
638 4.3. Naming Conventions
640 4.3.1. Variable Names
644 Use all lowercase, and separate words via an underscore ('_'). Do not start an
645 identifier with an underscore. (ANSI C reserves these for use by the compiler
646 and system headers.) Do not use identifiers which are reserved in ANSI C++.
647 (E.g. template, class, true, false, ...). This is in case we ever decide to
651 int ms_iis5_hack = 0;
655 int msiis5hack = 0; int msIis5Hack = 0;
656 -------------------------------------------------------------------------------
658 4.3.2. Function Names
662 Use all lowercase, and separate words via an underscore ('_'). Do not start an
663 identifier with an underscore. (ANSI C reserves these for use by the compiler
664 and system headers.) Do not use identifiers which are reserved in ANSI C++.
665 (E.g. template, class, true, false, ...). This is in case we ever decide to
669 int load_some_file( struct client_state *csp )
673 int loadsomefile( struct client_state *csp )
674 int loadSomeFile( struct client_state *csp )
675 -------------------------------------------------------------------------------
677 4.3.3. Header file prototypes
681 Use a descriptive parameter name in the function prototype in header files. Use
682 the same parameter name in the header file that you use in the c file.
685 (.h) extern int load_aclfile( struct client_state *csp );
686 (.c) int load_aclfile( struct client_state *csp )
689 (.h) extern int load_aclfile( struct client_state * ); or
690 (.h) extern int load_aclfile();
691 (.c) int load_aclfile( struct client_state *csp )
692 -------------------------------------------------------------------------------
694 4.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
703 (enumeration) : enum Boolean { FALSE, TRUE };
704 (#define) : #define DEFAULT_SIZE 100;
706 Note: We have a standard naming scheme for #defines that toggle a feature in
707 the preprocessor: FEATURE_>, where > is a short (preferably 1 or 2 word)
711 #define FEATURE_FORCE 1
714 #define FORCE_PREFIX blah
715 #endif /* def FEATURE_FORCE */
716 -------------------------------------------------------------------------------
722 Spell common words out entirely (do not remove vowels).
724 Use only widely-known domain acronyms and abbreviations. Capitalize all letters
727 Use underscore (_) to separate adjacent acronyms and abbreviations. Never
728 terminate a name with an underscore.
731 #define USE_IMAGE_LIST 1
735 #define USE_IMG_LST 1 or
736 #define _USE_IMAGE_LIST 1 or
737 #define USE_IMAGE_LIST_ 1 or
738 #define use_image_list 1 or
739 #define UseImageList 1
740 -------------------------------------------------------------------------------
744 4.4.1. Put braces on a line by themselves.
748 The brace needs to be on a line all by itself, not at the end of the statement.
749 Curly braces should line up with the construct that they're associated with.
750 This practice makes it easier to identify the opening and closing braces for a
761 if ( this == that ) { ... }
765 if ( this == that ) { ... }
767 Note: In the special case that the if-statement is inside a loop, and it is
768 trivial, i.e. it tests for a condition that is obvious from the purpose of the
769 block, one-liners as above may optically preserve the loop structure and make
772 Status: developer-discretion.
775 while ( more lines are read )
777 /* Please document what is/is not a comment line here */
778 if ( it's a comment ) continue;
780 do_something( line );
782 -------------------------------------------------------------------------------
784 4.4.2. ALL control statements should have a block
788 Using braces to make a block will make your code more readable and less prone
789 to error. All control statements should have a block defined.
800 if ( this == that ) DoSomething(); DoSomethingElse();
804 if ( this == that ) DoSomething();
806 Note: The first example in "Instead of" will execute in a manner other than
807 that which the developer desired (per indentation). Using code braces would
808 have prevented this "feature". The "explanation" and "exception" from the point
810 -------------------------------------------------------------------------------
812 4.4.3. Do not belabor/blow-up boolean expressions
815 structure->flag = ( condition );
819 if ( condition ) { structure->flag = 1; } else { structure->flag = 0; }
821 Note: The former is readable and concise. The later is wordy and inefficient.
822 Please assume that any developer new to the project has at least a "good"
823 knowledge of C/C++. (Hope I do not offend by that last comment ... 8-)
824 -------------------------------------------------------------------------------
826 4.4.4. Use white space freely because it is free
830 Make it readable. The notable exception to using white space freely is listed
831 in the next guideline.
836 int anotherValue = 0;
837 int thisVariable = 0;
839 if ( thisVariable == thatVariable )
841 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
842 -------------------------------------------------------------------------------
844 4.4.5. Don't use white space around structure operators
848 - structure pointer operator ( "->" ) - member operator ( "." ) - functions and
851 It is a general coding practice to put pointers, references, and function
852 parentheses next to names. With spaces, the connection between the object and
853 variable/function name is not as clear.
860 Instead of: aStruct -> aMember; aStruct . aMember; FunctionName ();
861 -------------------------------------------------------------------------------
863 4.4.6. Make the last brace of a function stand out
871 } /* -END- function1 */
876 } /* -END- function2 */
880 int function1( ... ) { ...code... return( retCode ); } int function2( ... ) { }
882 Note: Use 1 blank line before the closing brace and 2 lines afterward. This
883 makes the end of function standout to the most casual viewer. Although function
884 comments help separate functions, this is still a good coding practice. In
885 fact, I follow these rules when using blocks in "for", "while", "do" loops, and
886 long if {} statements too. After all whitespace is free!
888 Status: developer-discretion on the number of blank lines. Enforced is the end
889 of function comments.
890 -------------------------------------------------------------------------------
892 4.4.7. Use 3 character indentions
896 If some use 8 character TABs and some use 3 character TABs, the code can look *
897 very* ragged. So use 3 character indentions only. If you like to use TABs, pass
898 your code through a filter such as "expand -t3" before checking in your code.
901 static const char * const url_code_map[256] =
911 return( ALWAYS_TRUE );
915 return( HOW_DID_YOU_GET_HERE );
918 return( NEVER_GETS_HERE );
921 -------------------------------------------------------------------------------
925 4.5.1. Initialize all variables
929 Do not assume that the variables declared will not be used until after they
930 have been assigned a value somewhere else in the code. Remove the chance of
931 accidentally using an unassigned variable.
938 Note: It is much easier to debug a SIGSEGV if the message says you are trying
939 to access memory address 00000000 and not 129FA012; or arrayPtr[20] causes a
940 SIGSEV vs. arrayPtr[0].
942 Status: developer-discretion if and only if the variable is assigned a value
943 "shortly after" declaration.
944 -------------------------------------------------------------------------------
948 4.6.1. Name functions that return a boolean as a question.
952 Value should be phrased as a question that would logically be answered as a
953 true or false statement
959 -------------------------------------------------------------------------------
961 4.6.2. Always specify a return type for a function.
965 The default return for a function is an int. To avoid ambiguity, create a
966 return for a function when the return has a purpose, and create a void return
967 type if the function does not need to return anything.
968 -------------------------------------------------------------------------------
970 4.6.3. Minimize function calls when iterating by using variables
974 It is easy to write the following code, and a clear argument can be made that
975 the code is easy to understand:
978 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
983 Note: Unfortunately, this makes a function call for each and every iteration.
984 This increases the overhead in the program, because the compiler has to look up
985 the function each time, call it, and return a value. Depending on what occurs
986 in the blockListLength() call, it might even be creating and destroying
987 structures with each iteration, even though in each case it is comparing "cnt"
988 to the same value, over and over. Remember too - even a call to blockListLength
989 () is a function call, with the same overhead.
991 Instead of using a function call during the iterations, assign the value to a
992 variable, and evaluate using the variable.
995 size_t len = blockListLength();
997 for ( size_t cnt = 0; cnt < len; cnt ++ )
1002 Exceptions: if the value of blockListLength() *may* change or could *
1003 potentially* change, then you must code the function call in the for/while
1005 -------------------------------------------------------------------------------
1007 4.6.4. Pass and Return by Const Reference
1011 This allows a developer to define a const pointer and call your function. If
1012 your function does not have the const keyword, we may not be able to use your
1013 function. Consider strcmp, if it were defined as: extern int strcmp( char *s1,
1016 I could then not use it to compare argv's in main: int main( int argc, const
1017 char *argv[] ) { strcmp( argv[0], "privoxy" ); }
1019 Both these pointers are *const*! If the c runtime library maintainers do it, we
1021 -------------------------------------------------------------------------------
1023 4.6.5. Pass and Return by Value
1027 Most structures cannot fit onto a normal stack entry (i.e. they are not 4 bytes
1028 or less). Aka, a function declaration like: int load_aclfile( struct
1031 would not work. So, to be consistent, we should declare all prototypes with
1032 "pass by value": int load_aclfile( struct client_state *csp )
1033 -------------------------------------------------------------------------------
1035 4.6.6. Names of include files
1039 Your include statements should contain the file name without a path. The path
1040 should be listed in the Makefile, using -I as processor directive to search the
1041 indicated paths. An exception to this would be for some proprietary software
1042 that utilizes a partial path to distinguish their header files from system or
1046 #include <iostream.h> /* This is not a local include */
1047 #include "config.h" /* This IS a local include */
1051 /* This is not a local include, but requires a path element. */
1052 #include <sys/fileName.h>
1054 Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
1055 This duplicates the #include "file.h" behavior.
1056 -------------------------------------------------------------------------------
1058 4.6.7. Provide multiple inclusion protection
1062 Prevents compiler and linker errors resulting from redefinition of items.
1064 Wrap each header file with the following syntax to prevent multiple inclusions
1065 of the file. Of course, replace PROJECT_H with your file name, with "." Changed
1066 to "_", and make it uppercase.
1069 #ifndef PROJECT_H_INCLUDED
1070 #define PROJECT_H_INCLUDED
1072 #endif /* ndef PROJECT_H_INCLUDED */
1073 -------------------------------------------------------------------------------
1075 4.6.8. Use `extern "C"` when appropriate
1079 If our headers are included from C++, they must declare our functions as
1080 `extern "C"`. This has no cost in C, but increases the potential re-usability
1087 #endif /* def __cplusplus */
1089 ... function definitions here ...
1093 #endif /* def __cplusplus */
1094 -------------------------------------------------------------------------------
1096 4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
1100 Useful in headers that include pointers to other struct's. Modifications to
1101 excess header files may cause needless compiles.
1104 /*********************************************************************
1105 * We're avoiding an include statement here!
1106 *********************************************************************/
1108 extern file_list *xyz;
1110 Note: If you declare "file_list xyz;" (without the pointer), then including the
1111 proper header file is necessary. If you only want to prototype a pointer,
1112 however, the header file is unnecessary.
1114 Status: Use with discretion.
1115 -------------------------------------------------------------------------------
1117 4.7. General Coding Practices
1119 4.7.1. Turn on warnings
1123 Compiler warnings are meant to help you find bugs. You should turn on as many
1124 as possible. With GCC, the switch is "-Wall". Try and fix as many warnings as
1126 -------------------------------------------------------------------------------
1128 4.7.2. Provide a default case for all switch statements
1132 What you think is guaranteed is never really guaranteed. The value that you
1133 don't think you need to check is the one that someday will be passed. So, to
1134 protect yourself from the unknown, always have a default step in a switch
1138 switch( hash_string( cmd ) )
1140 case hash_actions_file :
1150 ... anomaly code goes here ...
1151 continue; / break; / exit( 1 ); / etc ...
1153 } /* end switch( hash_string( cmd ) ) */
1155 Note: If you already have a default condition, you are obviously exempt from
1156 this point. Of note, most of the WIN32 code calls `DefWindowProc' after the
1157 switch statement. This API call *should* be included in a default statement.
1159 Another Note: This is not so much a readability issue as a robust programming
1160 issue. The "anomaly code goes here" may be no more than a print to the STDERR
1161 stream (as in load_config). Or it may really be an ABEND condition.
1163 Status: Programmer discretion is advised.
1164 -------------------------------------------------------------------------------
1166 4.7.3. Try to avoid falling through cases in a switch statement.
1170 In general, you will want to have a 'break' statement within each 'case' of a
1171 switch statement. This allows for the code to be more readable and
1172 understandable, and furthermore can prevent unwanted surprises if someone else
1173 later gets creative and moves the code around.
1175 The language allows you to plan the fall through from one case statement to
1176 another simply by omitting the break statement within the case statement. This
1177 feature does have benefits, but should only be used in rare cases. In general,
1178 use a break statement for each case statement.
1180 If you choose to allow fall through, you should comment both the fact of the
1181 fall through and reason why you felt it was necessary.
1182 -------------------------------------------------------------------------------
1184 4.7.4. Use 'long' or 'short' Instead of 'int'
1188 On 32-bit platforms, int usually has the range of long. On 16-bit platforms,
1189 int has the range of short.
1191 Status: open-to-debate. In the case of most FSF projects (including X/
1192 GNU-Emacs), there are typedefs to int4, int8, int16, (or equivalence ... I
1193 forget the exact typedefs now). Should we add these to IJB now that we have a
1195 -------------------------------------------------------------------------------
1197 4.7.5. Don't mix size_t and other types
1201 The type of size_t varies across platforms. Do not make assumptions about
1202 whether it is signed or unsigned, or about how long it is. Do not compare a
1203 size_t against another variable of a different type (or even against a
1204 constant) without casting one of the values. Try to avoid using size_t if you
1206 -------------------------------------------------------------------------------
1208 4.7.6. Declare each variable and struct on its own line.
1212 It can be tempting to declare a series of variables all on one line. Don't.
1223 Explanation: - there is more room for comments on the individual variables -
1224 easier to add new variables without messing up the original ones - when
1225 searching on a variable to find its type, there is less clutter to "visually"
1228 Exceptions: when you want to declare a bunch of loop variables or other trivial
1229 variables; feel free to declare them on 1 line. You should, although, provide a
1230 good comment on their functions.
1232 Status: developer-discretion.
1233 -------------------------------------------------------------------------------
1235 4.7.7. Use malloc/zalloc sparingly
1239 Create a local struct (on the stack) if the variable will live and die within
1240 the context of one function call.
1242 Only "malloc" a struct (on the heap) if the variable's life will extend beyond
1243 the context of one function call.
1246 If a function creates a struct and stores a pointer to it in a
1247 list, then it should definitely be allocated via `malloc'.
1248 -------------------------------------------------------------------------------
1250 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
1254 If you have to "malloc" an instance, you are responsible for insuring that the
1255 instance is `free'd, even if the deallocation event falls within some other
1256 programmer's code. You are also responsible for ensuring that deletion is
1257 timely (i.e. not too soon, not too late). This is known as "low-coupling" and
1258 is a "good thing (tm)". You may need to offer a free/unload/destructor type
1259 function to accommodate this.
1262 int load_re_filterfile( struct client_state *csp ) { ... }
1263 static void unload_re_filterfile( void *f ) { ... }
1267 The developer cannot be expected to provide `free'ing functions for C run-time
1268 library functions ... such as `strdup'.
1270 Status: developer-discretion. The "main" use of this standard is for allocating
1271 and freeing data structures (complex or nested).
1272 -------------------------------------------------------------------------------
1274 4.7.9. Add loaders to the `file_list' structure and in order
1278 I have ordered all of the "blocker" file code to be in alpha order. It is
1279 easier to add/read new blockers when you expect a certain order.
1281 Note: It may appear that the alpha order is broken in places by POPUP tests
1282 coming before PCRS tests. But since POPUPs can also be referred to as
1283 KILLPOPUPs, it is clear that it should come first.
1284 -------------------------------------------------------------------------------
1286 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
1290 If you have enough confidence in new code or confidence in your changes, but
1291 are not *quite* sure of the repercussions, add this:
1293 /* FIXME: this code has a logic error on platform XYZ, * attempting to fix */ #
1294 ifdef PLATFORM ...changed code here... #endif
1298 /* FIXME: I think the original author really meant this... */ ...changed code
1303 /* FIXME: new code that *may* break something else... */ ...new code here...
1305 Note: If you make it clear that this may or may not be a "good thing (tm)", it
1306 will be easier to identify and include in the project (or conversely exclude
1308 -------------------------------------------------------------------------------
1310 4.8. Addendum: Template for files and function comment blocks:
1312 Example for file comments:
1313 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.6 2002/08/10 11:40:25 oes Exp $";
1314 /*********************************************************************
1318 * Purpose : (Fill me in with a good description!)
1320 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1321 * Privoxy team. http://www.privoxy.org/
1323 * Based on the Internet Junkbuster originally written
1324 * by and Copyright (C) 1997 Anonymous Coders and
1325 * Junkbusters Corporation. http://www.junkbusters.com
1327 * This program is free software; you can redistribute it
1328 * and/or modify it under the terms of the GNU General
1329 * Public License as published by the Free Software
1330 * Foundation; either version 2 of the License, or (at
1331 * your option) any later version.
1333 * This program is distributed in the hope that it will
1334 * be useful, but WITHOUT ANY WARRANTY; without even the
1335 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1336 * PARTICULAR PURPOSE. See the GNU General Public
1337 * License for more details.
1339 * The GNU General Public License should be included with
1340 * this file. If not, you can view it at
1341 * http://www.gnu.org/copyleft/gpl.html
1342 * or write to the Free Software Foundation, Inc., 59
1343 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1348 *********************************************************************/
1353 ...necessary include files for us to do our work...
1355 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1357 Note: This declares the rcs variables that should be added to the
1358 "show-proxy-args" page. If this is a brand new creation by you, you are free to
1359 change the "Copyright" section to represent the rights you wish to maintain.
1361 Note: The formfeed character that is present right after the comment flower box
1362 is handy for (X|GNU)Emacs users to skip the verbiage and get to the heart of
1363 the code (via `forward-page' and `backward-page'). Please include it if you
1366 Example for file header comments:
1369 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.6 2002/08/10 11:40:25 oes Exp $"
1370 /*********************************************************************
1374 * Purpose : (Fill me in with a good description!)
1376 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1377 * Privoxy team. http://www.privoxy.org/
1379 * Based on the Internet Junkbuster originally written
1380 * by and Copyright (C) 1997 Anonymous Coders and
1381 * Junkbusters Corporation. http://www.junkbusters.com
1383 * This program is free software; you can redistribute it
1384 * and/or modify it under the terms of the GNU General
1385 * Public License as published by the Free Software
1386 * Foundation; either version 2 of the License, or (at
1387 * your option) any later version.
1389 * This program is distributed in the hope that it will
1390 * be useful, but WITHOUT ANY WARRANTY; without even the
1391 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1392 * PARTICULAR PURPOSE. See the GNU General Public
1393 * License for more details.
1395 * The GNU General Public License should be included with
1396 * this file. If not, you can view it at
1397 * http://www.gnu.org/copyleft/gpl.html
1398 * or write to the Free Software Foundation, Inc., 59
1399 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1404 *********************************************************************/
1407 #include "project.h"
1413 ... function headers here ...
1416 /* Revision control strings from this header and associated .c file */
1417 extern const char FILENAME_rcs[];
1418 extern const char FILENAME_h_rcs[];
1425 #endif /* ndef _FILENAME_H */
1433 Example for function comments:
1434 /*********************************************************************
1436 * Function : FUNCTION_NAME
1438 * Description : (Fill me in with a good description!)
1441 * 1 : param1 = pointer to an important thing
1442 * 2 : x = pointer to something else
1444 * Returns : 0 => Ok, everything else is an error.
1446 *********************************************************************/
1447 int FUNCTION_NAME( void *param1, const char *x )
1454 Note: If we all follow this practice, we should be able to parse our code to
1455 create a "self-documenting" web page.
1456 -------------------------------------------------------------------------------
1458 5. Testing Guidelines
1461 -------------------------------------------------------------------------------
1463 5.1. Testplan for releases
1465 Explain release numbers. major, minor. developer releases. etc.
1467 1. Remove any existing rpm with rpm -e
1469 2. Remove any file that was left over. This includes (but is not limited to)
1477 + /etc/init.d/privoxy
1482 3. Install the rpm. Any error messages?
1484 4. start,stop,status Privoxy with the specific script (e.g. /etc/rc.d/init/
1485 privoxy stop). Reboot your machine. Does autostart work?
1487 5. Start browsing. Does Privoxy work? Logfile written?
1489 6. Remove the rpm. Any error messages? All files removed?
1492 -------------------------------------------------------------------------------
1495 Please submit test reports only with the test form at sourceforge. Three simple
1498 * Select category: the distribution you test on.
1500 * Select group: the version of Privoxy that we are about to release.
1502 * Fill the Summary and Detailed Description with something intelligent (keep
1503 it short and precise).
1506 Do not mail to the mailing list (we cannot keep track on issues there).
1507 -------------------------------------------------------------------------------
1509 6. Releasing a New Version
1511 When we release versions of Privoxy, our work leaves our cozy secret lab and
1512 has to work in the cold RealWorld[tm]. Once it is released, there is no way to
1513 call it back, so it is very important that great care is taken to ensure that
1514 everything runs fine, and not to introduce problems in the very last minute.
1516 So when releasing a new version, please adhere exactly to the procedure
1517 outlined in this chapter.
1519 The following programs are required to follow this process: ncftpput (ncftp),
1520 scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs.
1521 -------------------------------------------------------------------------------
1523 6.1. Version numbers
1525 First you need to determine which version number the release will have. Privoxy
1526 version numbers consist of three numbers, separated by dots, like in X.Y.Z,
1529 * X, the version major, is rarely ever changed. It is increased by one if
1530 turning a development branch into stable substantially changes the
1531 functionality, user interface or configuration syntax. Majors 1 and 2 were
1532 Junkbuster, and 3 will be the first stable Privoxy release.
1534 * Y, the version minor, represents the branch within the major version. At
1535 any point in time, there are two branches being maintained: The stable
1536 branch, with an even minor, say, 2N, in which no functionality is being
1537 added and only bug-fixes are made, and 2N+1, the development branch, in
1538 which the further development of Privoxy takes place. This enables us to
1539 turn the code upside down and inside out, while at the same time providing
1540 and maintaining a stable version. The minor is reset to zero (and one) when
1541 the major is incremented. When a development branch has matured to the
1542 point where it can be turned into stable, the old stable branch 2N is given
1543 up (i.e. no longer maintained), the former development branch 2N+1 becomes
1544 the new stable branch 2N+2, and a new development branch 2N+3 is opened.
1546 * Z, the point or sub version, represents a release of the software within a
1547 branch. It is therefore incremented immediately before each code freeze. In
1548 development branches, only the even point versions correspond to actual
1549 releases, while the odd ones denote the evolving state of the sources on
1550 CVS in between. It follows that Z is odd on CVS in development branches
1551 most of the time. There, it gets increased to an even number immediately
1552 before a code freeze, and is increased to an odd number again immediately
1553 thereafter. This ensures that builds from CVS snapshots are easily
1554 distinguished from released versions. The point version is reset to zero
1555 when the minor changes.
1558 -------------------------------------------------------------------------------
1559 6.2. Before the Release: Freeze
1561 The following must be done by one of the developers prior to each new release.
1563 * Make sure that everybody who has worked on the code in the last couple of
1564 days has had a chance to yell "no!" in case they have pending changes/fixes
1565 in their pipelines. Announce the freeze so that nobody will interfere with
1566 last minute changes.
1568 * Increment the version number (point from odd to even in development
1569 branches!) in configure.in. (RPM spec files will need to be incremented as
1572 * If default.action has changed since last release (i.e. software release or
1573 standalone actions file release), bump up its version info to A.B in this
1576 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
1578 Then change the version info in doc/webserver/actions/index.php, line:
1579 '$required_actions_file_version = "A.B";'
1581 * All documentation should be rebuild after the version bump. Finished docs
1582 should be then be committed to CVS (for those without the ability to build
1583 these). Some docs may require rather obscure processing tools. config, the
1584 man page (and the html version of the man page), and the PDF docs fall in
1585 this category. REAMDE, the man page, AUTHORS, and config should all also be
1586 committed to CVS for other packageers. The formal docs should be uploaded
1587 to the webserver. See the Section "Updating the webserver" in this manual
1590 * All developers should look at the ChangeLog and make sure noteworthy
1591 changes are referenced.
1593 * Commit all files that were changed in the above steps!
1595 * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
1596 use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
1598 * If the release was in a development branch, increase the point version from
1599 even to odd (X.Y.(Z+1)) again in configure.in and commit your change.
1601 * On the webserver, copy the user manual to a new top-level directory called
1602 X.Y.Z. This ensures that help links from the CGI pages, which have the
1603 version as a prefix, will go into the right version of the manual. If this
1604 is a development branch release, also symlink X.Y.(Z-1) to X.Y.Z and X.Y.
1605 (Z+1) to . (i.e. dot).
1608 -------------------------------------------------------------------------------
1609 6.3. Building and Releasing the Packages
1611 Now the individual packages can be built and released. Note that for GPL
1612 reasons the first package to be released is always the source tarball.
1614 For all types of packages, including the source tarball, you must make sure
1615 that you build from clean sources by exporting the right version from CVS into
1616 an empty directory (just press return when asked for a password):
1618 mkdir dist # delete or choose different name if it already exists
1620 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1621 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1623 Do NOT change a single bit, including, but not limited to version information
1624 after export from CVS. This is to make sure that all release packages, and with
1625 them, all future bug reports, are based on exactly the same code.
1627 Please find additional instructions for the source tarball and the individual
1628 platform dependent binary packages below. And details on the Sourceforge
1629 release process below that.
1630 -------------------------------------------------------------------------------
1632 6.3.1. Note on Privoxy Packaging
1634 Please keep these general guidelines in mind when putting together your
1635 package. These apply to all platforms!
1637 * Privoxy requires write access to: all *.action files, all logfiles, and the
1638 trust file. You will need to determine the best way to do this for your
1641 * Please include up to date documentation. At a bare minimum:
1643 LICENSE (top-level directory)
1645 README (top-level directory)
1647 AUTHORS (top-level directory)
1649 man page (top-level directory, Unix-like platforms only)
1651 The User Manual (doc/webserver/user-manual/)
1653 FAQ (doc/webserver/faq/)
1655 Also suggested: Developer Manual (doc/webserver/developer-manual) and
1656 ChangeLog (top-level directory). FAQ and the manuals are HTML docs. There
1657 are also text versions in doc/text/ which could conceivably also be
1660 The documentation has been designed such that the manuals are linked to
1661 each other from parallel directories, and should be packaged that way.
1662 privoxy-index.html can also be included and can serve as a focal point for
1663 docs and other links of interest (and possibly renamed to index.html). This
1664 should be one level up from the manuals. There is a link also on this page
1665 to an HTMLized version of the man page. To avoid 404 for this, it is in CVS
1666 as doc/webserver/man-page/privoxy-man-page.html, and should be included
1667 along with the manuals. There is also a css stylesheets that can be
1668 included for better presentation: p_doc.css. This should be in the same
1669 directory with privoxy-index.html, (i.e. one level up from the manual
1672 * user.action is designed for local preferences. Make sure this does not get
1675 * Other configuration files should be installed as the new defaults, but all
1676 previously installed configuration files should be preserved as backups.
1677 This is just good manners :-)
1679 * Please check platform specific notes in this doc, if you haven't done
1680 "Privoxy" packaging before for other platform specific issues. Conversely,
1681 please add any notes that you know are important for your platform (or
1682 contact one of the doc maintainers to do this if you can't).
1684 * Packagers should do a "clean" install of their package after building it.
1685 So any previous installs should be removed first to ensure the integrity of
1686 the newly built package. Then run the package for a while to make sure
1687 there are no obvious problems, before uploading.
1690 -------------------------------------------------------------------------------
1691 6.3.2. Source Tarball
1693 First, make sure that you have freshly exported the right version into an empty
1694 directory. (See "Building and releasing packages" above). Then run:
1697 autoheader && autoconf && ./configure
1703 To upload the package to Sourceforge, simply issue
1707 Go to the displayed URL and release the file publicly on Sourceforge. For the
1708 change log field, use the relevant section of the ChangeLog file.
1709 -------------------------------------------------------------------------------
1711 6.3.3. SuSE, Conectiva or Red Hat RPM
1713 In following text, replace dist with either "rh" for Red Hat or "suse" for
1716 First, make sure that you have freshly exported the right version into an empty
1717 directory. (See "Building and releasing packages" above).
1719 As the only exception to not changing anything after export from CVS, now
1720 examine the file privoxy-dist.spec and make sure that the version information
1721 and the RPM release number are correct. The RPM release numbers for each
1722 version start at one. Hence it must be reset to one if this is the first RPM
1723 for dist which is built from version X.Y.Z. Check the file list if unsure.
1724 Else, it must be set to the highest already available RPM release number for
1725 that version plus one.
1730 autoheader && autoconf && ./configure
1736 To upload the package to Sourceforge, simply issue
1738 make dist-upload rpm_packagerev
1740 where rpm_packagerev is the RPM release number as determined above. Go to the
1741 displayed URL and release the file publicly on Sourceforge. Use the release
1742 notes and change log from the source tarball package.
1743 -------------------------------------------------------------------------------
1747 First, make sure that you have freshly exported the right version into an empty
1748 directory. (See "Building and releasing packages" above). Then get the OS/2
1751 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
1753 You will need a mix of development tools. The main compilation takes place with
1754 IBM Visual Age C++. Some ancillary work takes place with GNU tools, available
1755 from various sources like hobbes.nmsu.edu. Specificially, you will need
1756 autoheader, autoconf and sh tools. The packaging takes place with WarpIN,
1757 available from various sources, including its home page: xworkplace.
1759 Change directory to the os2setup directory. Edit the os2build.cmd file to set
1760 the final executable filename. For example,
1762 installExeName='privoxyos2_setup_X.Y.Z.exe'
1764 Next, edit the IJB.wis file so the release number matches in the PACKAGEID
1767 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
1769 You're now ready to build. Run:
1773 You will find the WarpIN-installable executable in the ./files directory.
1774 Upload this anonymously to uploads.sourceforge.net/incoming, create a release
1775 for it, and you're done. Use the release notes and Change Log from the source
1777 -------------------------------------------------------------------------------
1781 Login to Sourceforge's compilefarm via ssh:
1783 ssh cf.sourceforge.net
1785 Choose the right operating system (not the Debian one). When logged in, make
1786 sure that you have freshly exported the right version into an empty directory.
1787 (See "Building and releasing packages" above). Then run:
1790 autoheader && autoconf && ./configure
1796 which creates a gzip'ed tar archive. Sadly, you cannot use make solaris-upload
1797 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1798 archive to Sourceforge's ftp server and release the file publicly. Use the
1799 release notes and Change Log from the source tarball package.
1800 -------------------------------------------------------------------------------
1804 You should ensure you have the latest version of Cygwin (from http://
1805 www.cygwin.com/). Run the following commands from within a Cygwin bash shell.
1807 First, make sure that you have freshly exported the right version into an empty
1808 directory. (See "Building and releasing packages" above). Then get the Windows
1811 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
1813 Then you can build the package. This is fully automated, and is controlled by
1814 winsetup/GNUmakefile. All you need to do is:
1819 Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
1820 upload it to SourceForge. When releasing the package on SourceForge, use the
1821 release notes and Change Log from the source tarball package.
1822 -------------------------------------------------------------------------------
1826 First, make sure that you have freshly exported the right version into an empty
1827 directory. (See "Building and releasing packages" above). Then add a log entry
1828 to debian/changelog, if it is not already there, for example by running:
1830 debchange -v 2.9.20-beta-1 "New upstream version"
1834 dpkg-buildpackage -rfakeroot -us -uc -b
1836 This will create ../privoxy_2.9.20-beta-1_i386.deb which can be uploaded. To
1837 upload the package to Sourceforge, simply issue
1840 -------------------------------------------------------------------------------
1844 First, make sure that you have freshly exported the right version into an empty
1845 directory. (See "Building and releasing packages" above). Then get the Mac OSX
1848 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
1855 This will run autoheader, autoconf and configure as well as make. Finally, it
1856 will copy over the necessary files to the ./osxsetup/files directory for
1857 further processing by PackageMaker.
1859 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the
1860 package name to match the release, and hit the "Create package" button. If you
1861 specify ./Privoxy.pkg as the output package name, you can then create the
1862 distributable zip file with the command:
1864 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
1866 You can then upload privoxyosx_setup_x.y.z.zip anonymously to
1867 uploads.sourceforge.net/incoming, create a release for it, and you're done. Use
1868 the release notes and Change Log from the source tarball package.
1869 -------------------------------------------------------------------------------
1873 Login to Sourceforge's compile-farm via ssh:
1875 ssh cf.sourceforge.net
1877 Choose the right operating system. When logged in, make sure that you have
1878 freshly exported the right version into an empty directory. (See "Building and
1879 releasing packages" above). Then run:
1882 autoheader && autoconf && ./configure
1888 which creates a gzip'ed tar archive. Sadly, you cannot use make freebsd-upload
1889 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1890 archive to Sourceforge's ftp server and release the file publicly. Use the
1891 release notes and Change Log from the source tarball package.
1892 -------------------------------------------------------------------------------
1896 First, make sure that you have freshly exported the right version into an empty
1897 directory. (See "Building and releasing packages" above). Then run:
1900 autoheader && autoconf && ./configure
1903 -------------------------------------------------------------------------------
1907 First, make sure that you have freshly exported the right version into an empty
1908 directory. (See "Building and releasing packages" above). Then run:
1911 autoheader && autoconf && ./configure
1914 -------------------------------------------------------------------------------
1918 Login to Sourceforge's compilefarm via ssh:
1920 ssh cf.sourceforge.net
1922 Choose the right operating system. When logged in, make sure that you have
1923 freshly exported the right version into an empty directory. (See "Building and
1924 releasing packages" above). Then run:
1927 autoheader && autoconf && ./configure
1933 which creates a gzip'ed tar archive. Sadly, you cannot use make aix-upload on
1934 the Sourceforge machine (no ncftpput). You now have to manually upload the
1935 archive to Sourceforge's ftp server and release the file publicly. Use the
1936 release notes and Change Log from the source tarball package.
1937 -------------------------------------------------------------------------------
1939 6.4. Uploading and Releasing Your Package
1941 After the package is ready, it is time to upload it to SourceForge, and go
1942 through the release steps. The upload is done via FTP:
1944 * Upload to: ftp://upload.sourceforge.net/incoming
1948 * password: ijbswa-developers@lists.sourceforge.net
1951 Or use the make targets as described above.
1953 Once this done go to http://sourceforge.net/project/admin/editpackages.php?
1954 group_id=11118, making sure you are logged in. Find your target platform in the
1955 second column, and click Add Release. You will then need to create a new
1956 release for your package, using the format of $VERSION ($CODE_STATUS), e.g.
1959 Now just follow the prompts. Be sure to add any appropriate Release notes. You
1960 should see your freshly uploaded packages in "Step 2. Add Files To This
1961 Release". Check the appropriate box(es). Remember at each step to hit the
1962 "Refresh/Submit" buttons! You should now see your file(s) listed in Step 3.
1963 Fill out the forms with the appropriate information for your platform, being
1964 sure to hit "Update" for each file. If anyone is monitoring your platform,
1965 check the "email" box at the very bottom to notify them of the new package.
1968 If you have made errors, or need to make changes, you can go through
1969 essentially the same steps, but select Edit Release, instead of Add Release.
1970 -------------------------------------------------------------------------------
1972 6.5. After the Release
1974 When all (or: most of the) packages have been uploaded and made available, send
1975 an email to the announce mailing list, Subject: "Version X.Y.Z available for
1976 download". Be sure to include the download location, the release notes and the
1978 -------------------------------------------------------------------------------
1980 7. Update the Webserver
1982 When updating the webserver, please follow these steps to make sure that no
1983 broken links, inconsistent contents or permission problems will occur:
1985 If you have changed anything in the documentation source SGML files, do:
1987 make dok # (or make redhat-dok if make dok doesn't work for you)
1989 That will generate doc/webserver/user-manual, doc/webserver/developer-manual,
1990 doc/webserver/faq and doc/webserver/index.html automatically.
1992 If you changed the manual page source, generate doc/webserver/man-page/
1993 privoxy-man-page.html by running "make man". (This is a separate target due to
1994 dependencies on some obscure perl scripts. See comments in GNUmakefile.)
1996 If you want to add new files to the webserver, create them locally in the doc/
1997 webserver/* directory (or create new directories under doc/webserver).
1999 Next, commit any changes from the above steps to CVS. All set? Then do
2003 This will do the upload to the webserver (www.privoxy.org) and ensure all files
2004 and directories there are group writable.
2006 Please do NOT use any other means of transferring files to the webserver to
2007 avoid permission problems.
2008 -------------------------------------------------------------------------------
2010 8. Contacting the developers, Bug Reporting and Feature Requests
2012 We value your feedback. In fact, we rely on it to improve Privoxy and its
2013 configuration. However, please note the following hints, so we can provide you
2014 with the best support:
2015 -------------------------------------------------------------------------------
2019 For casual users, our support forum at SourceForge is probably best suited:
2020 http://sourceforge.net/tracker/?group_id=11118&atid=211118
2022 All users are of course welcome to discuss their issues on the users mailing
2023 list, where the developers also hang around.
2024 -------------------------------------------------------------------------------
2028 Please report all bugs only through our bug tracker: http://sourceforge.net/
2029 tracker/?group_id=11118&atid=111118.
2031 Before doing so, please make sure that the bug has not already been submitted
2032 and observe the additional hints at the top of the submit form.
2034 Please try to verify that it is a Privoxy bug, and not a browser or site bug
2035 first. If unsure, try toggling off Privoxy, and see if the problem persists.
2036 The appendix of the user manual also has helpful information on action
2037 debugging. If you are using your own custom configuration, please try the stock
2038 configs to see if the problem is configuration related.
2040 If not using the latest version, chances are that the bug has been found and
2041 fixed in the meantime. We would appreciate if you could take the time to
2042 upgrade to the latest version (or even the latest CVS snapshot) and verify your
2043 bug, but this is not required for reporting.
2044 -------------------------------------------------------------------------------
2046 8.3. Request New Features
2048 You are welcome to submit ideas on new features or other proposals for
2049 improvement through our feature request tracker at http://sourceforge.net/
2050 tracker/?atid=361118&group_id=11118.
2051 -------------------------------------------------------------------------------
2053 8.4. Report Ads or Other Actions-Related Problems
2055 Please send feedback on ads that slipped through, innocent images that were
2056 blocked, and any other problems relating to the default.action file through our
2057 actions feedback mechanism located at http://www.privoxy.org/actions/. On this
2058 page, you will also find a bookmark which will take you back there from any
2059 troubled site and even pre-fill the form!
2061 New, improved default.action files will occasionally be made available based on
2062 your feedback. These will be announced on the ijbswa-announce list and
2063 available from our the files section of our project page.
2064 -------------------------------------------------------------------------------
2068 For any other issues, feel free to use the mailing lists. Technically
2069 interested users and people who wish to contribute to the project are also
2070 welcome on the developers list! You can find an overview of all Privoxy-related
2071 mailing lists, including list archives, at: http://sourceforge.net/mail/?
2073 -------------------------------------------------------------------------------
2075 9. Privoxy Copyright, License and History
2077 Copyright © 2001, 2002 by Privoxy Developers <developers@privoxy.org>
2079 Some source code is based on code Copyright © 1997 by Anonymous Coders and
2080 Junkbusters, Inc. and licensed under the GNU General Public License.
2081 -------------------------------------------------------------------------------
2085 Privoxy is free software; you can redistribute it and/or modify it under the
2086 terms of the GNU General Public License, version 2, as published by the Free
2087 Software Foundation.
2089 This program is distributed in the hope that it will be useful, but WITHOUT ANY
2090 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
2091 PARTICULAR PURPOSE. See the GNU General Public License for more details, which
2092 is available from the Free Software Foundation, Inc, 59 Temple Place - Suite
2093 330, Boston, MA 02111-1307, USA.
2095 You should have received a copy of the GNU General Public License along with
2096 this program; if not, write to the
2099 Foundation, Inc. 59 Temple Place - Suite 330
2100 Boston, MA 02111-1307
2102 -------------------------------------------------------------------------------
2106 In the beginning, there was the Internet Junkbuster, by Anonymous Coders and
2107 Junkbusters Corporation. It saved many users a lot of pain in the early days of
2108 web advertising and user tracking.
2110 But the web, its protocols and standards, and with it, the techniques for
2111 forcing users to consume ads, give up autonomy over their browsing, and for
2112 spying on them, kept evolving. Unfortunately, the Internet Junkbuster did not.
2113 Version 2.0.2, published in 1998, was (and is) the last official release
2114 available from Junkbusters Corporation. Fortunately, it had been released under
2115 the GNU GPL, which allowed further development by others.
2117 So Stefan Waldherr started maintaining an improved version of the software, to
2118 which eventually a number of people contributed patches. It could already
2119 replace banners with a transparent image, and had a first version of pop-up
2120 killing, but it was still very closely based on the original, with all its
2121 limitations, such as the lack of HTTP/1.1 support, flexible per-site
2122 configuration, or content modification. The last release from this effort was
2123 version 2.0.2-10, published in 2000.
2125 Then, some developers picked up the thread, and started turning the software
2126 inside out, upside down, and then reassembled it, adding many new features
2129 The result of this is Privoxy, whose first stable release, 3.0, is due late
2130 summer or early fall 2002.
2131 -------------------------------------------------------------------------------
2135 Other references and sites of interest to Privoxy users:
2137 http://www.privoxy.org/, the Privoxy Home page.
2139 http://www.privoxy.org/faq/, the Privoxy FAQ.
2141 http://sourceforge.net/projects/ijbswa/, the Project Page for Privoxy on
2144 http://config.privoxy.org/, the web-based user interface. Privoxy must be
2145 running for this to work. Shortcut: http://p.p/
2147 http://www.privoxy.org/actions/, to submit "misses" to the developers.
2149 http://www.junkbusters.com/ht/en/cookies.html, an explanation how cookies are
2150 used to track web users.
2152 http://www.junkbusters.com/ijb.html, the original Internet Junkbuster.
2154 http://www.waldherr.org/junkbuster/, Stefan Waldherr's version of Junkbuster,
2155 from which Privoxy was derived.
2157 http://privacy.net/analyze/, a useful site to check what information about you
2158 is leaked while you browse the web.
2160 http://www.squid-cache.org/, a very popular caching proxy, which is often used
2161 together with Privoxy.
2163 http://www.privoxy.org/developer-manual/, the Privoxy developer manual.