1 Privoxy Developer Manual
3 Copyright © 2001, 2002 by Privoxy Developers
5 $Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd 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 You can find the latest version of the this manual at http://www.privoxy.org/
14 developer-manual/. Please see the Contact section on how to contact the
17 -------------------------------------------------------------------------------
20 1.1. Quickstart to Privoxy Development
25 2.2. CVS Commit Guideline
26 2.3. Discussing Changes First
29 3. Documentation Guidelines
30 3.1. Quickstart to Docbook and SGML
31 3.2. Privoxy Documentation Style
32 3.3. Privoxy Custom Entities
38 4.2.1. Comment, Comment, Comment
39 4.2.2. Use blocks for comments
40 4.2.3. Keep Comments on their own line
41 4.2.4. Comment each logical step
42 4.2.5. Comment All Functions Thoroughly
43 4.2.6. Comment at the end of braces if the content is more than one
47 4.3. Naming Conventions
50 4.3.3. Header file prototypes
51 4.3.4. Enumerations, and #defines
56 4.4.1. Put braces on a line by themselves.
57 4.4.2. ALL control statements should have a block
58 4.4.3. Do not belabor/blow-up boolean expressions
59 4.4.4. Use white space freely because it is free
60 4.4.5. Don't use white space around structure operators
61 4.4.6. Make the last brace of a function stand out
62 4.4.7. Use 3 character indentions
66 4.5.1. Initialize all variables
70 4.6.1. Name functions that return a boolean as a question.
71 4.6.2. Always specify a return type for a function.
72 4.6.3. Minimize function calls when iterating by using variables
73 4.6.4. Pass and Return by Const Reference
74 4.6.5. Pass and Return by Value
75 4.6.6. Names of include files
76 4.6.7. Provide multiple inclusion protection
77 4.6.8. Use `extern "C"` when appropriate
78 4.6.9. Where Possible, Use Forward Struct Declaration Instead of
82 4.7. General Coding Practices
83 4.7.1. Turn on warnings
84 4.7.2. Provide a default case for all switch statements
85 4.7.3. Try to avoid falling through cases in a switch statement.
86 4.7.4. Use 'long' or 'short' Instead of 'int'
87 4.7.5. Don't mix size_t and other types
88 4.7.6. Declare each variable and struct on its own line.
89 4.7.7. Use malloc/zalloc sparingly
90 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
92 4.7.9. Add loaders to the `file_list' structure and in order
93 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
96 4.8. Addendum: Template for files and function comment blocks:
100 5.1. Testplan for releases
104 6. Releasing a New Version
106 6.2. Before the Release: Freeze
107 6.3. Building and Releasing the Packages
108 6.3.1. Note on Privoxy Packaging
109 6.3.2. Source Tarball
110 6.3.3. SuSE, Conectiva or Red Hat RPM
122 6.4. Uploading and Releasing Your Package
123 6.5. After the Release
126 7. Update the Webserver
127 8. Contacting the developers, Bug Reporting and Feature Requests
130 8.3. Request New Features
131 8.4. Report Ads or Other Actions-Related Problems
135 9. Privoxy Copyright, License and History
144 Privoxy, as an heir to Junkbuster, is an Open Source project and licensed under
145 the GPL. As such, Privoxy development is potentially open to anyone who has the
146 time, knowledge, and desire to contribute in any capacity. Our goals are simply
147 to continue the mission, to improve Privoxy, and to make it available to as
148 wide an audience as possible.
150 One does not have to be a programmer to contribute. Packaging, testing, and
151 porting, are all important jobs as well.
152 -------------------------------------------------------------------------------
154 1.1. Quickstart to Privoxy Development
156 You'll need an account on Sourceforge to support our development. Mail your ID
157 to the list and wait until a project manager has added you.
159 For the time being (read, this section is under construction), please refer to
160 the extensive comments in the source code.
161 -------------------------------------------------------------------------------
163 2. The CVS Repository
165 If you intend to help us with programming, documentation or packaging you will
166 need write access to our holy grail, the CVS repository. Please read this
167 chapter completely before accessing via CVS.
168 -------------------------------------------------------------------------------
172 The project's CVS repository is hosted on SourceForge. Please refer to the
173 chapters 6 and 7 in SF's site documentation for the technical access details
174 for your operating system. For historical reasons, the CVS server is called
175 cvs.ijbswa.sourceforge.net, the repository is called ijbswa, and the source
176 tree module is called current.
177 -------------------------------------------------------------------------------
179 2.2. CVS Commit Guideline
181 The source tree is the heart of every software project. Every effort must be
182 made to ensure that it is readable, compilable and consistent at all times. We
183 therefore ask anyone with CVS access to strictly adhere to the following
186 * Never (read: never, ever) be tempted to commit that small change without
187 testing it thoroughly first. When we're close to a public release, ask a
188 fellow developer to review your changes.
190 * Your commit message should give a concise overview of what you changed (no
191 big details) and why you changed it Just check previous messages for good
194 * Don't use the same message on multiple files, unless it equally applies to
197 * If your changes span multiple files, and the code won't recompile unless
198 all changes are committed (e.g. when changing the signature of a function),
199 then commit all files one after another, without long delays in between. If
200 necessary, prepare the commit messages in advance.
202 * Before changing things on CVS, make sure that your changes are in line with
203 the team's general consensus on what should be done (see below).
206 -------------------------------------------------------------------------------
207 2.3. Discussing Changes First
209 We don't have a too formal policy on this, just use common sense. Hints: If it
212 1. ..a bug-fix / clean-up / cosmetic thing: shoot
214 2. ..a new feature that can be turned off: shoot
216 3. ..a clear improvement w/o side effects on other parts of the code: shoot
218 4. ..a matter of taste: ask the list
220 5. ..a major redesign of some part of the code: ask the list
223 Note that near a major public release, we get a bit more cautious - if unsure,
224 it doesn't hurt to ask first. There is always the possibility to submit a patch
225 to the patches tracker instead.
226 -------------------------------------------------------------------------------
228 3. Documentation Guidelines
230 All formal documents are maintained in Docbook SGML and located in the doc/
231 source/* directory. You will need Docbook, the Docbook DTD's and the Docbook
232 modular stylesheets (or comparable alternatives), and either jade or openjade
233 (recommended) installed in order to build docs from source. Currently there is
234 user-manual, FAQ, and, of course this, the developer-manual in this format. The
235 README, AUTHORS privoxy.1 (man page) files are also now maintained as Docbook
236 SGML. The finished files are all in the top-level source directory are
237 generated files! Also, index.html, the Privoxy home page, is maintained as
238 SGML. DO NOT edit these directly. Edit the SGML source, or contact someone
239 involved in the documentation (at present Stefan and Hal).
241 Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain
242 text files in the top-level source directory. At least for the time being.
244 Packagers are encouraged to include this documentation. For those without the
245 ability to build the docs locally, text versions of each are kept in CVS. HTML
246 versions are also now being kept in CVS under doc/webserver/*.
248 Formal documents are built with the Makefile targets of make dok, or
249 alternately make redhat-dok. If you have problems, try both. The build process
250 uses the document SGML sources in doc/source/*/* to update all text files in
251 doc/text/ and to update all HTML documents in doc/webserver/.
253 Documentation writers should please make sure documents build successfully
254 before committing to CVS, if possible.
256 How do you update the webserver (i.e. the pages on privoxy.org)?
258 1. First, build the docs by running make dok (or alternately make redhat-dok).
260 2. Run make webserver which copies all files from doc/webserver to the
261 sourceforge webserver via scp.
264 Finished docs should be occasionally submitted to CVS (doc/webserver/*/*.html)
265 so that those without the ability to build them locally, have access to them if
266 needed. This is especially important just prior to a new release! Please do
267 this after the $VERSION and other release specific data in configure.in has
268 been updated (this is done just prior to a new release).
269 -------------------------------------------------------------------------------
271 3.1. Quickstart to Docbook and SGML
273 If you are not familiar with SGML, it is a markup language similar to HTML.
274 Actually, not a mark up language per se, but a language used to define markup
275 languages. In fact, HTML is an SGML application. Both will use "tags" to format
276 text and other content. SGML tags can be much more varied, and flexible, but do
277 much of the same kinds of things. The tags, or "elements", are definable in
278 SGML. There is no set "standards". Since we are using Docbook, our tags are
279 those that are defined by Docbook. Much of how the finish document is rendered
280 is determined by the "stylesheets". The stylesheets determine how each tag gets
281 translated to HTML, or other formats.
283 Tags in Docbook SGML need to be always "closed". If not, you will likely
284 generate errors. Example: <title>My Title</title>. They are also
285 case-insensitive, but we strongly suggest using all lower case. This keeps
286 compatibility with [Docbook] XML.
288 Our documents use "sections" for the most part. Sections will be processed into
289 HTML headers (e.g. h1 for sect1). The Docbook stylesheets will use these to
290 also generate the Table of Contents for each doc. Our TOC's are set to a depth
291 of three. Meaning sect1, sect2, and sect3 will have TOC entries, but sect4 will
292 not. Each section requires a <title> element, and at least one <para>. There is
293 a limit of five section levels in Docbook, but generally three should be
294 sufficient for our purposes.
296 Some common elements that you likely will use:
298 <para></para>, paragraph delimiter. Most text needs to be within paragraph
299 elements (there are some exceptions).
300 <emphasis></emphasis>, the stylesheets make this italics.
301 <filename></filename>, files and directories.
302 <command></command>, command examples.
303 <literallayout></literallayout>, like <pre>, more or less.
304 <itemizedlist></itemizedlist>, list with bullets.
305 <listitem></listitem>, member of the above.
306 <screen></screen>, screen output, implies <literallayout>.
307 <ulink url="example.com"></ulink>, like HTML <a> tag.
308 <quote></quote>, for, doh, quoting text.
310 Look at any of the existing docs for examples of all these and more.
312 You might also find "Writing Documentation Using DocBook - A Crash Course"
314 -------------------------------------------------------------------------------
316 3.2. Privoxy Documentation Style
318 It will be easier if everyone follows a similar writing style. This just makes
319 it easier to read what someone else has written if it is all done in a similar
324 * All tags should be lower case.
326 * Tags delimiting a block of text (even small blocks) should be on their own
333 Tags marking individual words, or few words, should be in-line:
335 Just to <emphasis>emphasize</emphasis>, some text goes here.
338 * Tags should be nested and step indented for block text like: (except
345 Some text goes here in our list example.
351 This makes it easier to find the text amongst the tags ;-)
352 * Use white space to separate logical divisions within a document, like
353 between sections. Running everything together consistently makes it harder
356 * Do not hesitate to make comments. Comments can either use the <comment>
357 element, or the <!-- --> style comment familiar from HTML. (Note in Docbook
358 v4.x <comment> is replaced by <remark>.)
360 * We have an international audience. Refrain from slang, or English
361 idiosyncrasies (too many to list :). Humor also does not translate well
364 * Try to keep overall line lengths in source files to 80 characters or less
365 for obvious reasons. This is not always possible, with lengthy URLs for
368 * Our documents are available in differing formats. Right now, they are just
369 plain text, and HTML, but PDF, and others is always a future possibility.
370 Be careful with URLs (<ulink>), and avoid this mistake:
372 My favorite site is <ulink url="http://example.com">here</ulink>.
374 This will render as "My favorite site is here", which is not real helpful
375 in a text doc. Better like this:
377 My favorite site is <ulink url="http://example.com">example.com</ulink>.
379 * All documents should be spell checked occasionally. aspell can check SGML
380 with the -H option. (ispell I think too.)
383 -------------------------------------------------------------------------------
384 3.3. Privoxy Custom Entities
386 Privoxy documentation is using a number of customized "entities" to facilitate
387 documentation maintenance.
389 We are using a set of "boilerplate" files with generic text, that is used by
390 multiple docs. This way we can write something once, and use it repeatedly
391 without having to re-write the same content over and over again. If editing
392 such a file, keep in mind that it should be generic. That is the purpose; so it
393 can be used in varying contexts without additional modifications.
395 We are also using what Docbook calls "internal entities". These are like
396 variables in programming. Well, sort of. For instance, we have the p-version
397 entity that contains the current Privoxy version string. You are strongly
398 encouraged to use these where possible. Some of these obviously require
399 re-setting with each release (done by the Makefile). A sampling of custom
400 entities are listed below. See any of the main docs for examples.
402 * Re- "boilerplate" text entities are defined like:
404 <!entity supported SYSTEM "supported.sgml">
406 In this example, the contents of the file, supported.sgml is available for
407 inclusion anywhere in the doc. To make this happen, just reference the now
408 defined entity: &supported; (starts with an ampersand and ends with a
409 semi-colon), and the contents will be dumped into the finished doc at that
412 * Commonly used "internal entities":
414 p-version: the Privoxy version string, e.g. "2.9.18".
415 p-status: the project status, either "alpha", "beta", or "stable".
416 p-not-stable: use to conditionally include text in "not stable" releases
418 p-stable: just the opposite.
419 p-text: this doc is only generated as text.
423 There are others in various places that are defined for a specific purpose.
425 -------------------------------------------------------------------------------
431 This set of standards is designed to make our lives easier. It is developed
432 with the simple goal of helping us keep the "new and improved Privoxy"
433 consistent and reliable. Thus making maintenance easier and increasing chances
434 of success of the project.
436 And that of course comes back to us as individuals. If we can increase our
437 development and product efficiencies then we can solve more of the request for
438 changes/improvements and in general feel good about ourselves. ;->
439 -------------------------------------------------------------------------------
443 4.2.1. Comment, Comment, Comment
447 Comment as much as possible without commenting the obvious. For example do not
448 comment "aVariable is equal to bVariable". Instead explain why aVariable should
449 be equal to the bVariable. Just because a person can read code does not mean
450 they will understand why or what is being done. A reader may spend a lot more
451 time figuring out what is going on when a simple comment or explanation would
452 have prevented the extra research. Please help your brother IJB'ers out!
454 The comments will also help justify the intent of the code. If the comment
455 describes something different than what the code is doing then maybe a
456 programming error is occurring.
459 /* if page size greater than 1k ... */
460 if ( PageLength() > 1024 )
462 ... "block" the page up ...
465 /* if page size is small, send it in blocks */
466 if ( PageLength() > 1024 )
468 ... "block" the page up ...
471 This demonstrates 2 cases of "what not to do". The first is a
472 "syntax comment". The second is a comment that does not fit what
473 is actually being done.
474 -------------------------------------------------------------------------------
476 4.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.
486 /*********************************************************************
487 * This will stand out clearly in your code!
488 *********************************************************************/
489 if ( thisVariable == thatVariable )
491 DoSomethingVeryImportant();
495 /* unfortunately, this may not */
496 if ( thisVariable == thatVariable )
498 DoSomethingVeryImportant();
502 if ( thisVariable == thatVariable ) /* this may not either */
504 DoSomethingVeryImportant();
509 If you are trying to add a small logic comment and do not wish to "disrupt" the
510 flow of the code, feel free to use a 1 line comment which is NOT on the same
512 -------------------------------------------------------------------------------
514 4.2.3. Keep Comments on their own line
518 It goes back to the question of readability. If the comment is on the same line
519 as the code it will be harder to read than the comment that is on its own line.
521 There are three exceptions to this rule, which should be violated freely and
522 often: during the definition of variables, at the end of closing braces, when
523 used to comment parameters.
526 /*********************************************************************
527 * This will stand out clearly in your code,
528 * But the second example won't.
529 *********************************************************************/
530 if ( thisVariable == thatVariable )
532 DoSomethingVeryImportant();
535 if ( thisVariable == thatVariable ) /*can you see me?*/
537 DoSomethingVeryImportant(); /*not easily*/
541 /*********************************************************************
542 * But, the encouraged exceptions:
543 *********************************************************************/
544 int urls_read = 0; /* # of urls read + rejected */
545 int urls_rejected = 0; /* # of urls rejected */
549 DoSomethingVeryImportant();
553 short DoSomethingVeryImportant(
554 short firstparam, /* represents something */
555 short nextparam /* represents something else */ )
559 } /* -END- DoSomethingVeryImportant */
560 -------------------------------------------------------------------------------
562 4.2.4. Comment each logical step
566 Logical steps should be commented to help others follow the intent of the
567 written code and comments will make the code more readable.
569 If you have 25 lines of code without a comment, you should probably go back
570 into it to see where you forgot to put one.
572 Most "for", "while", "do", etc... loops _probably_ need a comment. After all,
573 these are usually major logic containers.
574 -------------------------------------------------------------------------------
576 4.2.5. Comment All Functions Thoroughly
580 A reader of the code should be able to look at the comments just prior to the
581 beginning of a function and discern the reason for its existence and the
582 consequences of using it. The reader should not have to read through the code
583 to determine if a given function is safe for a desired use. The proper
584 information thoroughly presented at the introduction of a function not only
585 saves time for subsequent maintenance or debugging, it more importantly aids in
586 code reuse by allowing a user to determine the safety and applicability of any
587 function for the problem at hand. As a result of such benefits, all functions
588 should contain the information presented in the addendum section of this
590 -------------------------------------------------------------------------------
592 4.2.6. Comment at the end of braces if the content is more than one screen
597 Each closing brace should be followed on the same line by a comment that
598 describes the origination of the brace if the original brace is off of the
599 screen, or otherwise far away from the closing brace. This will simplify the
600 debugging, maintenance, and readability of the code.
602 As a suggestion , use the following flags to make the comment and its brace
605 use following a closing brace: } /* -END- if() or while () or etc... */
610 DoSomethingVeryImportant();
611 ...some long list of commands...
612 } /* -END- if x is 1 */
618 DoSomethingVeryImportant();
619 ...some long list of commands...
620 } /* -END- if ( 1 == X ) */
621 -------------------------------------------------------------------------------
623 4.3. Naming Conventions
625 4.3.1. Variable Names
629 Use all lowercase, and separate words via an underscore ('_'). Do not start an
630 identifier with an underscore. (ANSI C reserves these for use by the compiler
631 and system headers.) Do not use identifiers which are reserved in ANSI C++.
632 (E.g. template, class, true, false, ...). This is in case we ever decide to
636 int ms_iis5_hack = 0;
640 int msiis5hack = 0; int msIis5Hack = 0;
641 -------------------------------------------------------------------------------
643 4.3.2. Function Names
647 Use all lowercase, and separate words via an underscore ('_'). Do not start an
648 identifier with an underscore. (ANSI C reserves these for use by the compiler
649 and system headers.) Do not use identifiers which are reserved in ANSI C++.
650 (E.g. template, class, true, false, ...). This is in case we ever decide to
654 int load_some_file( struct client_state *csp )
658 int loadsomefile( struct client_state *csp )
659 int loadSomeFile( struct client_state *csp )
660 -------------------------------------------------------------------------------
662 4.3.3. Header file prototypes
666 Use a descriptive parameter name in the function prototype in header files. Use
667 the same parameter name in the header file that you use in the c file.
670 (.h) extern int load_aclfile( struct client_state *csp );
671 (.c) int load_aclfile( struct client_state *csp )
674 (.h) extern int load_aclfile( struct client_state * ); or
675 (.h) extern int load_aclfile();
676 (.c) int load_aclfile( struct client_state *csp )
677 -------------------------------------------------------------------------------
679 4.3.4. Enumerations, and #defines
683 Use all capital letters, with underscores between words. Do not start an
684 identifier with an underscore. (ANSI C reserves these for use by the compiler
688 (enumeration) : enum Boolean { FALSE, TRUE };
689 (#define) : #define DEFAULT_SIZE 100;
691 Note: We have a standard naming scheme for #defines that toggle a feature in
692 the preprocessor: FEATURE_>, where > is a short (preferably 1 or 2 word)
696 #define FEATURE_FORCE 1
699 #define FORCE_PREFIX blah
700 #endif /* def FEATURE_FORCE */
701 -------------------------------------------------------------------------------
707 Spell common words out entirely (do not remove vowels).
709 Use only widely-known domain acronyms and abbreviations. Capitalize all letters
712 Use underscore (_) to separate adjacent acronyms and abbreviations. Never
713 terminate a name with an underscore.
716 #define USE_IMAGE_LIST 1
720 #define USE_IMG_LST 1 or
721 #define _USE_IMAGE_LIST 1 or
722 #define USE_IMAGE_LIST_ 1 or
723 #define use_image_list 1 or
724 #define UseImageList 1
725 -------------------------------------------------------------------------------
729 4.4.1. Put braces on a line by themselves.
733 The brace needs to be on a line all by itself, not at the end of the statement.
734 Curly braces should line up with the construct that they're associated with.
735 This practice makes it easier to identify the opening and closing braces for a
746 if ( this == that ) { ... }
750 if ( this == that ) { ... }
752 Note: In the special case that the if-statement is inside a loop, and it is
753 trivial, i.e. it tests for a condition that is obvious from the purpose of the
754 block, one-liners as above may optically preserve the loop structure and make
757 Status: developer-discretion.
760 while ( more lines are read )
762 /* Please document what is/is not a comment line here */
763 if ( it's a comment ) continue;
765 do_something( line );
767 -------------------------------------------------------------------------------
769 4.4.2. ALL control statements should have a block
773 Using braces to make a block will make your code more readable and less prone
774 to error. All control statements should have a block defined.
785 if ( this == that ) DoSomething(); DoSomethingElse();
789 if ( this == that ) DoSomething();
791 Note: The first example in "Instead of" will execute in a manner other than
792 that which the developer desired (per indentation). Using code braces would
793 have prevented this "feature". The "explanation" and "exception" from the point
795 -------------------------------------------------------------------------------
797 4.4.3. Do not belabor/blow-up boolean expressions
800 structure->flag = ( condition );
804 if ( condition ) { structure->flag = 1; } else { structure->flag = 0; }
806 Note: The former is readable and concise. The later is wordy and inefficient.
807 Please assume that any developer new to the project has at least a "good"
808 knowledge of C/C++. (Hope I do not offend by that last comment ... 8-)
809 -------------------------------------------------------------------------------
811 4.4.4. Use white space freely because it is free
815 Make it readable. The notable exception to using white space freely is listed
816 in the next guideline.
821 int anotherValue = 0;
822 int thisVariable = 0;
824 if ( thisVariable == thatVariable )
826 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
827 -------------------------------------------------------------------------------
829 4.4.5. Don't use white space around structure operators
833 - structure pointer operator ( "->" ) - member operator ( "." ) - functions and
836 It is a general coding practice to put pointers, references, and function
837 parentheses next to names. With spaces, the connection between the object and
838 variable/function name is not as clear.
845 Instead of: aStruct -> aMember; aStruct . aMember; FunctionName ();
846 -------------------------------------------------------------------------------
848 4.4.6. Make the last brace of a function stand out
856 } /* -END- function1 */
861 } /* -END- function2 */
865 int function1( ... ) { ...code... return( retCode ); } int function2( ... ) { }
867 Note: Use 1 blank line before the closing brace and 2 lines afterward. This
868 makes the end of function standout to the most casual viewer. Although function
869 comments help separate functions, this is still a good coding practice. In
870 fact, I follow these rules when using blocks in "for", "while", "do" loops, and
871 long if {} statements too. After all whitespace is free!
873 Status: developer-discretion on the number of blank lines. Enforced is the end
874 of function comments.
875 -------------------------------------------------------------------------------
877 4.4.7. Use 3 character indentions
881 If some use 8 character TABs and some use 3 character TABs, the code can look *
882 very* ragged. So use 3 character indentions only. If you like to use TABs, pass
883 your code through a filter such as "expand -t3" before checking in your code.
886 static const char * const url_code_map[256] =
896 return( ALWAYS_TRUE );
900 return( HOW_DID_YOU_GET_HERE );
903 return( NEVER_GETS_HERE );
906 -------------------------------------------------------------------------------
910 4.5.1. Initialize all variables
914 Do not assume that the variables declared will not be used until after they
915 have been assigned a value somewhere else in the code. Remove the chance of
916 accidentally using an unassigned variable.
923 Note: It is much easier to debug a SIGSEGV if the message says you are trying
924 to access memory address 00000000 and not 129FA012; or arrayPtr[20] causes a
925 SIGSEV vs. arrayPtr[0].
927 Status: developer-discretion if and only if the variable is assigned a value
928 "shortly after" declaration.
929 -------------------------------------------------------------------------------
933 4.6.1. Name functions that return a boolean as a question.
937 Value should be phrased as a question that would logically be answered as a
938 true or false statement
944 -------------------------------------------------------------------------------
946 4.6.2. Always specify a return type for a function.
950 The default return for a function is an int. To avoid ambiguity, create a
951 return for a function when the return has a purpose, and create a void return
952 type if the function does not need to return anything.
953 -------------------------------------------------------------------------------
955 4.6.3. Minimize function calls when iterating by using variables
959 It is easy to write the following code, and a clear argument can be made that
960 the code is easy to understand:
963 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
968 Note: Unfortunately, this makes a function call for each and every iteration.
969 This increases the overhead in the program, because the compiler has to look up
970 the function each time, call it, and return a value. Depending on what occurs
971 in the blockListLength() call, it might even be creating and destroying
972 structures with each iteration, even though in each case it is comparing "cnt"
973 to the same value, over and over. Remember too - even a call to blockListLength
974 () is a function call, with the same overhead.
976 Instead of using a function call during the iterations, assign the value to a
977 variable, and evaluate using the variable.
980 size_t len = blockListLength();
982 for ( size_t cnt = 0; cnt < len; cnt ++ )
987 Exceptions: if the value of blockListLength() *may* change or could *
988 potentially* change, then you must code the function call in the for/while
990 -------------------------------------------------------------------------------
992 4.6.4. Pass and Return by Const Reference
996 This allows a developer to define a const pointer and call your function. If
997 your function does not have the const keyword, we may not be able to use your
998 function. Consider strcmp, if it were defined as: extern int strcmp( char *s1,
1001 I could then not use it to compare argv's in main: int main( int argc, const
1002 char *argv[] ) { strcmp( argv[0], "privoxy" ); }
1004 Both these pointers are *const*! If the c runtime library maintainers do it, we
1006 -------------------------------------------------------------------------------
1008 4.6.5. Pass and Return by Value
1012 Most structures cannot fit onto a normal stack entry (i.e. they are not 4 bytes
1013 or less). Aka, a function declaration like: int load_aclfile( struct
1016 would not work. So, to be consistent, we should declare all prototypes with
1017 "pass by value": int load_aclfile( struct client_state *csp )
1018 -------------------------------------------------------------------------------
1020 4.6.6. Names of include files
1024 Your include statements should contain the file name without a path. The path
1025 should be listed in the Makefile, using -I as processor directive to search the
1026 indicated paths. An exception to this would be for some proprietary software
1027 that utilizes a partial path to distinguish their header files from system or
1031 #include <iostream.h> /* This is not a local include */
1032 #include "config.h" /* This IS a local include */
1036 /* This is not a local include, but requires a path element. */
1037 #include <sys/fileName.h>
1039 Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
1040 This duplicates the #include "file.h" behavior.
1041 -------------------------------------------------------------------------------
1043 4.6.7. Provide multiple inclusion protection
1047 Prevents compiler and linker errors resulting from redefinition of items.
1049 Wrap each header file with the following syntax to prevent multiple inclusions
1050 of the file. Of course, replace PROJECT_H with your file name, with "." Changed
1051 to "_", and make it uppercase.
1054 #ifndef PROJECT_H_INCLUDED
1055 #define PROJECT_H_INCLUDED
1057 #endif /* ndef PROJECT_H_INCLUDED */
1058 -------------------------------------------------------------------------------
1060 4.6.8. Use `extern "C"` when appropriate
1064 If our headers are included from C++, they must declare our functions as
1065 `extern "C"`. This has no cost in C, but increases the potential re-usability
1072 #endif /* def __cplusplus */
1074 ... function definitions here ...
1078 #endif /* def __cplusplus */
1079 -------------------------------------------------------------------------------
1081 4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
1085 Useful in headers that include pointers to other struct's. Modifications to
1086 excess header files may cause needless compiles.
1089 /*********************************************************************
1090 * We're avoiding an include statement here!
1091 *********************************************************************/
1093 extern file_list *xyz;
1095 Note: If you declare "file_list xyz;" (without the pointer), then including the
1096 proper header file is necessary. If you only want to prototype a pointer,
1097 however, the header file is unnecessary.
1099 Status: Use with discretion.
1100 -------------------------------------------------------------------------------
1102 4.7. General Coding Practices
1104 4.7.1. Turn on warnings
1108 Compiler warnings are meant to help you find bugs. You should turn on as many
1109 as possible. With GCC, the switch is "-Wall". Try and fix as many warnings as
1111 -------------------------------------------------------------------------------
1113 4.7.2. Provide a default case for all switch statements
1117 What you think is guaranteed is never really guaranteed. The value that you
1118 don't think you need to check is the one that someday will be passed. So, to
1119 protect yourself from the unknown, always have a default step in a switch
1123 switch( hash_string( cmd ) )
1125 case hash_actions_file :
1135 ... anomaly code goes here ...
1136 continue; / break; / exit( 1 ); / etc ...
1138 } /* end switch( hash_string( cmd ) ) */
1140 Note: If you already have a default condition, you are obviously exempt from
1141 this point. Of note, most of the WIN32 code calls `DefWindowProc' after the
1142 switch statement. This API call *should* be included in a default statement.
1144 Another Note: This is not so much a readability issue as a robust programming
1145 issue. The "anomaly code goes here" may be no more than a print to the STDERR
1146 stream (as in load_config). Or it may really be an ABEND condition.
1148 Status: Programmer discretion is advised.
1149 -------------------------------------------------------------------------------
1151 4.7.3. Try to avoid falling through cases in a switch statement.
1155 In general, you will want to have a 'break' statement within each 'case' of a
1156 switch statement. This allows for the code to be more readable and
1157 understandable, and furthermore can prevent unwanted surprises if someone else
1158 later gets creative and moves the code around.
1160 The language allows you to plan the fall through from one case statement to
1161 another simply by omitting the break statement within the case statement. This
1162 feature does have benefits, but should only be used in rare cases. In general,
1163 use a break statement for each case statement.
1165 If you choose to allow fall through, you should comment both the fact of the
1166 fall through and reason why you felt it was necessary.
1167 -------------------------------------------------------------------------------
1169 4.7.4. Use 'long' or 'short' Instead of 'int'
1173 On 32-bit platforms, int usually has the range of long. On 16-bit platforms,
1174 int has the range of short.
1176 Status: open-to-debate. In the case of most FSF projects (including X/
1177 GNU-Emacs), there are typedefs to int4, int8, int16, (or equivalence ... I
1178 forget the exact typedefs now). Should we add these to IJB now that we have a
1180 -------------------------------------------------------------------------------
1182 4.7.5. Don't mix size_t and other types
1186 The type of size_t varies across platforms. Do not make assumptions about
1187 whether it is signed or unsigned, or about how long it is. Do not compare a
1188 size_t against another variable of a different type (or even against a
1189 constant) without casting one of the values. Try to avoid using size_t if you
1191 -------------------------------------------------------------------------------
1193 4.7.6. Declare each variable and struct on its own line.
1197 It can be tempting to declare a series of variables all on one line. Don't.
1208 Explanation: - there is more room for comments on the individual variables -
1209 easier to add new variables without messing up the original ones - when
1210 searching on a variable to find its type, there is less clutter to "visually"
1213 Exceptions: when you want to declare a bunch of loop variables or other trivial
1214 variables; feel free to declare them on 1 line. You should, although, provide a
1215 good comment on their functions.
1217 Status: developer-discretion.
1218 -------------------------------------------------------------------------------
1220 4.7.7. Use malloc/zalloc sparingly
1224 Create a local struct (on the stack) if the variable will live and die within
1225 the context of one function call.
1227 Only "malloc" a struct (on the heap) if the variable's life will extend beyond
1228 the context of one function call.
1231 If a function creates a struct and stores a pointer to it in a
1232 list, then it should definitely be allocated via `malloc'.
1233 -------------------------------------------------------------------------------
1235 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
1239 If you have to "malloc" an instance, you are responsible for insuring that the
1240 instance is `free'd, even if the deallocation event falls within some other
1241 programmer's code. You are also responsible for ensuring that deletion is
1242 timely (i.e. not too soon, not too late). This is known as "low-coupling" and
1243 is a "good thing (tm)". You may need to offer a free/unload/destructor type
1244 function to accommodate this.
1247 int load_re_filterfile( struct client_state *csp ) { ... }
1248 static void unload_re_filterfile( void *f ) { ... }
1252 The developer cannot be expected to provide `free'ing functions for C run-time
1253 library functions ... such as `strdup'.
1255 Status: developer-discretion. The "main" use of this standard is for allocating
1256 and freeing data structures (complex or nested).
1257 -------------------------------------------------------------------------------
1259 4.7.9. Add loaders to the `file_list' structure and in order
1263 I have ordered all of the "blocker" file code to be in alpha order. It is
1264 easier to add/read new blockers when you expect a certain order.
1266 Note: It may appear that the alpha order is broken in places by POPUP tests
1267 coming before PCRS tests. But since POPUPs can also be referred to as
1268 KILLPOPUPs, it is clear that it should come first.
1269 -------------------------------------------------------------------------------
1271 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
1275 If you have enough confidence in new code or confidence in your changes, but
1276 are not *quite* sure of the repercussions, add this:
1278 /* FIXME: this code has a logic error on platform XYZ, * attempting to fix */ #
1279 ifdef PLATFORM ...changed code here... #endif
1283 /* FIXME: I think the original author really meant this... */ ...changed code
1288 /* FIXME: new code that *may* break something else... */ ...new code here...
1290 Note: If you make it clear that this may or may not be a "good thing (tm)", it
1291 will be easier to identify and include in the project (or conversely exclude
1293 -------------------------------------------------------------------------------
1295 4.8. Addendum: Template for files and function comment blocks:
1297 Example for file comments:
1298 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $";
1299 /*********************************************************************
1303 * Purpose : (Fill me in with a good description!)
1305 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1306 * Privoxy team. http://www.privoxy.org/
1308 * Based on the Internet Junkbuster originally written
1309 * by and Copyright (C) 1997 Anonymous Coders and
1310 * Junkbusters Corporation. http://www.junkbusters.com
1312 * This program is free software; you can redistribute it
1313 * and/or modify it under the terms of the GNU General
1314 * Public License as published by the Free Software
1315 * Foundation; either version 2 of the License, or (at
1316 * your option) any later version.
1318 * This program is distributed in the hope that it will
1319 * be useful, but WITHOUT ANY WARRANTY; without even the
1320 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1321 * PARTICULAR PURPOSE. See the GNU General Public
1322 * License for more details.
1324 * The GNU General Public License should be included with
1325 * this file. If not, you can view it at
1326 * http://www.gnu.org/copyleft/gpl.html
1327 * or write to the Free Software Foundation, Inc., 59
1328 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1333 *********************************************************************/
1338 ...necessary include files for us to do our work...
1340 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1342 Note: This declares the rcs variables that should be added to the
1343 "show-proxy-args" page. If this is a brand new creation by you, you are free to
1344 change the "Copyright" section to represent the rights you wish to maintain.
1346 Note: The formfeed character that is present right after the comment flower box
1347 is handy for (X|GNU)Emacs users to skip the verbiage and get to the heart of
1348 the code (via `forward-page' and `backward-page'). Please include it if you
1351 Example for file header comments:
1354 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $"
1355 /*********************************************************************
1359 * Purpose : (Fill me in with a good description!)
1361 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1362 * Privoxy team. http://www.privoxy.org/
1364 * Based on the Internet Junkbuster originally written
1365 * by and Copyright (C) 1997 Anonymous Coders and
1366 * Junkbusters Corporation. http://www.junkbusters.com
1368 * This program is free software; you can redistribute it
1369 * and/or modify it under the terms of the GNU General
1370 * Public License as published by the Free Software
1371 * Foundation; either version 2 of the License, or (at
1372 * your option) any later version.
1374 * This program is distributed in the hope that it will
1375 * be useful, but WITHOUT ANY WARRANTY; without even the
1376 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1377 * PARTICULAR PURPOSE. See the GNU General Public
1378 * License for more details.
1380 * The GNU General Public License should be included with
1381 * this file. If not, you can view it at
1382 * http://www.gnu.org/copyleft/gpl.html
1383 * or write to the Free Software Foundation, Inc., 59
1384 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1389 *********************************************************************/
1392 #include "project.h"
1398 ... function headers here ...
1401 /* Revision control strings from this header and associated .c file */
1402 extern const char FILENAME_rcs[];
1403 extern const char FILENAME_h_rcs[];
1410 #endif /* ndef _FILENAME_H */
1418 Example for function comments:
1419 /*********************************************************************
1421 * Function : FUNCTION_NAME
1423 * Description : (Fill me in with a good description!)
1426 * 1 : param1 = pointer to an important thing
1427 * 2 : x = pointer to something else
1429 * Returns : 0 => Ok, everything else is an error.
1431 *********************************************************************/
1432 int FUNCTION_NAME( void *param1, const char *x )
1439 Note: If we all follow this practice, we should be able to parse our code to
1440 create a "self-documenting" web page.
1441 -------------------------------------------------------------------------------
1443 5. Testing Guidelines
1446 -------------------------------------------------------------------------------
1448 5.1. Testplan for releases
1450 Explain release numbers. major, minor. developer releases. etc.
1452 1. Remove any existing rpm with rpm -e
1454 2. Remove any file that was left over. This includes (but is not limited to)
1462 + /etc/init.d/privoxy
1467 3. Install the rpm. Any error messages?
1469 4. start,stop,status Privoxy with the specific script (e.g. /etc/rc.d/init/
1470 privoxy stop). Reboot your machine. Does autostart work?
1472 5. Start browsing. Does Privoxy work? Logfile written?
1474 6. Remove the rpm. Any error messages? All files removed?
1477 -------------------------------------------------------------------------------
1480 Please submit test reports only with the test form at sourceforge. Three simple
1483 * Select category: the distribution you test on.
1485 * Select group: the version of Privoxy that we are about to release.
1487 * Fill the Summary and Detailed Description with something intelligent (keep
1488 it short and precise).
1491 Do not mail to the mailing list (we cannot keep track on issues there).
1492 -------------------------------------------------------------------------------
1494 6. Releasing a New Version
1496 When we release versions of Privoxy, our work leaves our cozy secret lab and
1497 has to work in the cold RealWorld[tm]. Once it is released, there is no way to
1498 call it back, so it is very important that great care is taken to ensure that
1499 everything runs fine, and not to introduce problems in the very last minute.
1501 So when releasing a new version, please adhere exactly to the procedure
1502 outlined in this chapter.
1504 The following programs are required to follow this process: ncftpput (ncftp),
1505 scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs.
1506 -------------------------------------------------------------------------------
1508 6.1. Version numbers
1510 First you need to determine which version number the release will have. Privoxy
1511 version numbers consist of three numbers, separated by dots, like in X.Y.Z,
1514 * X, the version major, is rarely ever changed. It is increased by one if
1515 turning a development branch into stable substantially changes the
1516 functionality, user interface or configuration syntax. Majors 1 and 2 were
1517 Junkbuster, and 3 will be the first stable Privoxy release.
1519 * Y, the version minor, represents the branch within the major version. At
1520 any point in time, there are two branches being maintained: The stable
1521 branch, with an even minor, say, 2N, in which no functionality is being
1522 added and only bug-fixes are made, and 2N+1, the development branch, in
1523 which the further development of Privoxy takes place. This enables us to
1524 turn the code upside down and inside out, while at the same time providing
1525 and maintaining a stable version. The minor is reset to zero (and one) when
1526 the major is incremented. When a development branch has matured to the
1527 point where it can be turned into stable, the old stable branch 2N is given
1528 up (i.e. no longer maintained), the former development branch 2N+1 becomes
1529 the new stable branch 2N+2, and a new development branch 2N+3 is opened.
1531 * Z, the point or sub version, represents a release of the software within a
1532 branch. It is therefore incremented immediately before each code freeze. In
1533 development branches, only the even point versions correspond to actual
1534 releases, while the odd ones denote the evolving state of the sources on
1535 CVS in between. It follows that Z is odd on CVS in development branches
1536 most of the time. There, it gets increased to an even number immediately
1537 before a code freeze, and is increased to an odd number again immediately
1538 thereafter. This ensures that builds from CVS snapshots are easily
1539 distinguished from released versions. The point version is reset to zero
1540 when the minor changes.
1543 -------------------------------------------------------------------------------
1544 6.2. Before the Release: Freeze
1546 The following must be done by one of the developers prior to each new release.
1548 * Make sure that everybody who has worked on the code in the last couple of
1549 days has had a chance to yell "no!" in case they have pending changes/fixes
1550 in their pipelines. Announce the freeze so that nobody will interfere with
1551 last minute changes.
1553 * Increment the version number (point from odd to even in development
1554 branches!) in configure.in.
1556 * If default.action has changed since last release (i.e. software release or
1557 standalone actions file release), bump up its version info to A.B in this
1560 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
1562 Then change the version info in doc/webserver/actions/index.php, line:
1563 '$required_actions_file_version = "A.B";'
1565 * If the HTML documentation is not in sync with the SGML sources you need to
1566 regenerate and upload it to the webserver. (If in doubt, just do it.) See
1567 the Section "Updating the webserver" in this manual for details.
1569 * Commit all files that were changed in the above steps!
1571 * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
1572 use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
1574 * If the release was in a development branch, increase the point version from
1575 even to odd (X.Y.(Z+1)) again in configure.in and commit your change.
1577 * On the webserver, copy the user manual to a new top-level directory called
1578 X.Y.Z. This ensures that help links from the CGI pages, which have the
1579 version as a prefix, will go into the right version of the manual. If this
1580 is a development branch release, also symlink X.Y.(Z-1) to X.Y.Z and X.Y.
1581 (Z+1) to . (i.e. dot).
1584 -------------------------------------------------------------------------------
1585 6.3. Building and Releasing the Packages
1587 Now the individual packages can be built and released. Note that for GPL
1588 reasons the first package to be released is always the source tarball.
1590 For all types of packages, including the source tarball, you must make sure
1591 that you build from clean sources by exporting the right version from CVS into
1592 an empty directory:.
1594 mkdir dist # delete or choose different name if it already exists
1596 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1597 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1599 Do NOT change a single bit, including, but not limited to version information
1600 after export from CVS. This is to make sure that all release packages, and with
1601 them, all future bug reports, are based on exactly the same code.
1603 Please find additional instructions for the source tarball and the individual
1604 platform dependent binary packages below. And details on the Sourceforge
1605 release process below that.
1606 -------------------------------------------------------------------------------
1608 6.3.1. Note on Privoxy Packaging
1610 Please keep these general guidelines in mind when putting together your
1611 package. These apply to all platforms!
1613 * Privoxy requires write access to: all *.action files, all logfiles, and the
1614 trust file. You will need to determine the best way to do this for your
1617 * Please include up to date documentation. At a bare minimum:
1619 LICENSE (top-level directory)
1621 README (top-level directory)
1623 AUTHORS (top-level directory)
1625 man page (top-level directory, Unix-like platforms only)
1627 The User Manual (doc/webserver/user-manual/)
1629 FAQ (doc/webserver/faq/)
1631 Also suggested: Developer Manual (doc/webserver/developer-manual) and
1632 ChangeLog (top-level directory). FAQ and the manuals are HTML docs. There
1633 are also text versions in doc/text/ which could conceivably also be
1636 The documentation has been designed such that the manuals are linked to
1637 each other from parallel directories, and should be packaged that way.
1638 privoxy-index.html can also be included and can serve as a focal point for
1639 docs and other links of interest (and possibly renamed to index.html). This
1640 should be one level up from the manuals. There is a link also on this page
1641 to an HTMLized version of the man page. To avoid 404 for this, it is in CVS
1642 as doc/webserver/man-page/privoxy-man-page.html, and should be included
1643 along with the manuals. There is also a css stylesheets that can be
1644 included for better presentation: p_doc.css. This should be in the same
1645 directory with privoxy-index.html, (i.e. one level up from the manual
1648 * user.action is designed for local preferences. Make sure this does not get
1651 * Other configuration files should be installed as the new defaults, but all
1652 previously installed configuration files should be preserved as backups.
1653 This is just good manners :-)
1655 * Please check platform specific notes in this doc, if you haven't done
1656 "Privoxy" packaging before for other platform specific issues. Conversely,
1657 please add any notes that you know are important for your platform (or
1658 contact one of the doc maintainers to do this if you can't).
1661 -------------------------------------------------------------------------------
1662 6.3.2. Source Tarball
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
1674 To upload the package to Sourceforge, simply issue
1678 Go to the displayed URL and release the file publicly on Sourceforge. For the
1679 change log field, use the relevant section of the ChangeLog file.
1680 -------------------------------------------------------------------------------
1682 6.3.3. SuSE, Conectiva or Red Hat RPM
1684 In following text, replace dist with either "rh" for Red Hat or "suse" for
1687 First, make sure that you have freshly exported the right version into an empty
1688 directory. (See "Building and releasing packages" above).
1690 As the only exception to not changing anything after export from CVS, now
1691 examine the file privoxy-dist.spec and make sure that the version information
1692 and the RPM release number are correct. The RPM release numbers for each
1693 version start at one. Hence it must be reset to one if this is the first RPM
1694 for dist which is built from version X.Y.Z. Check the file list if unsure.
1695 Else, it must be set to the highest already available RPM release number for
1696 that version plus one.
1701 autoheader && autoconf && ./configure
1707 To upload the package to Sourceforge, simply issue
1709 make dist-upload rpm_packagerev
1711 where rpm_packagerev is the RPM release number as determined above. Go to the
1712 displayed URL and release the file publicly on Sourceforge. Use the release
1713 notes and change log from the source tarball package.
1714 -------------------------------------------------------------------------------
1718 First, make sure that you have freshly exported the right version into an empty
1719 directory. (See "Building and releasing packages" above). Then get the OS/2
1722 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
1724 You will need a mix of development tools. The main compilation takes place with
1725 IBM Visual Age C++. Some ancillary work takes place with GNU tools, available
1726 from various sources like hobbes.nmsu.edu. Specificially, you will need
1727 autoheader, autoconf and sh tools. The packaging takes place with WarpIN,
1728 available from various sources, including its home page: xworkplace.
1730 Change directory to the os2setup directory. Edit the os2build.cmd file to set
1731 the final executable filename. For example,
1733 installExeName='privoxyos2_setup_X.Y.Z.exe'
1735 Next, edit the IJB.wis file so the release number matches in the PACKAGEID
1738 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
1740 You're now ready to build. Run:
1744 You will find the WarpIN-installable executable in the ./files directory.
1745 Upload this anonymously to uploads.sourceforge.net/incoming, create a release
1746 for it, and you're done. Use the release notes and Change Log from the source
1748 -------------------------------------------------------------------------------
1752 Login to Sourceforge's compilefarm via ssh:
1754 ssh cf.sourceforge.net
1756 Choose the right operating system (not the Debian one). When logged in, make
1757 sure that you have freshly exported the right version into an empty directory.
1758 (See "Building and releasing packages" above). Then run:
1761 autoheader && autoconf && ./configure
1767 which creates a gzip'ed tar archive. Sadly, you cannot use make solaris-upload
1768 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1769 archive to Sourceforge's ftp server and release the file publicly. Use the
1770 release notes and Change Log from the source tarball package.
1771 -------------------------------------------------------------------------------
1775 You should ensure you have the latest version of Cygwin (from http://
1776 www.cygwin.com/). Run the following commands from within a Cygwin bash shell.
1778 First, make sure that you have freshly exported the right version into an empty
1779 directory. (See "Building and releasing packages" above). Then get the Windows
1782 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
1784 Then you can build the package. This is fully automated, and is controlled by
1785 winsetup/GNUmakefile. All you need to do is:
1790 Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
1791 upload it to SourceForge. When releasing the package on SourceForge, use the
1792 release notes and Change Log from the source tarball package.
1793 -------------------------------------------------------------------------------
1797 First, make sure that you have freshly exported the right version into an empty
1798 directory. (See "Building and releasing packages" above). Then add a log entry
1799 to debian/changelog, if it is not already there, for example by running:
1801 debchange -v 2.9.18-beta-1 "New upstream version"
1805 dpkg-buildpackage -rfakeroot -us -uc -b
1807 This will create ../privoxy_2.9.18-beta-1_i386.deb which can be uploaded. To
1808 upload the package to Sourceforge, simply issue
1811 -------------------------------------------------------------------------------
1815 First, make sure that you have freshly exported the right version into an empty
1816 directory. (See "Building and releasing packages" above). Then get the Mac OSX
1819 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
1826 This will run autoheader, autoconf and configure as well as make. Finally, it
1827 will copy over the necessary files to the ./osxsetup/files directory for
1828 further processing by PackageMaker.
1830 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the
1831 package name to match the release, and hit the "Create package" button. If you
1832 specify ./Privoxy.pkg as the output package name, you can then create the
1833 distributable zip file with the command:
1835 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
1837 You can then upload privoxyosx_setup_x.y.z.zip anonymously to
1838 uploads.sourceforge.net/incoming, create a release for it, and you're done. Use
1839 the release notes and Change Log from the source tarball package.
1840 -------------------------------------------------------------------------------
1844 Login to Sourceforge's compile-farm via ssh:
1846 ssh cf.sourceforge.net
1848 Choose the right operating system. When logged in, make sure that you have
1849 freshly exported the right version into an empty directory. (See "Building and
1850 releasing packages" above). Then run:
1853 autoheader && autoconf && ./configure
1859 which creates a gzip'ed tar archive. Sadly, you cannot use make freebsd-upload
1860 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1861 archive to Sourceforge's ftp server and release the file publicly. Use the
1862 release notes and Change Log from the source tarball package.
1863 -------------------------------------------------------------------------------
1867 First, make sure that you have freshly exported the right version into an empty
1868 directory. (See "Building and releasing packages" above). Then run:
1871 autoheader && autoconf && ./configure
1874 -------------------------------------------------------------------------------
1878 First, make sure that you have freshly exported the right version into an empty
1879 directory. (See "Building and releasing packages" above). Then run:
1882 autoheader && autoconf && ./configure
1885 -------------------------------------------------------------------------------
1889 Login to Sourceforge's compilefarm via ssh:
1891 ssh cf.sourceforge.net
1893 Choose the right operating system. When logged in, make sure that you have
1894 freshly exported the right version into an empty directory. (See "Building and
1895 releasing packages" above). Then run:
1898 autoheader && autoconf && ./configure
1904 which creates a gzip'ed tar archive. Sadly, you cannot use make aix-upload on
1905 the Sourceforge machine (no ncftpput). You now have to manually upload the
1906 archive to Sourceforge's ftp server and release the file publicly. Use the
1907 release notes and Change Log from the source tarball package.
1908 -------------------------------------------------------------------------------
1910 6.4. Uploading and Releasing Your Package
1912 After the package is ready, it is time to upload it to SourceForge, and go
1913 through the release steps. The upload is done via FTP:
1915 * Upload to: ftp://upload.sourceforge.net/incoming
1919 * password: ijbswa-developers@lists.sourceforge.net
1922 Or use the make targets as described above.
1924 Once this done go to http://sourceforge.net/project/admin/editpackages.php?
1925 group_id=11118, making sure you are logged in. Find your target platform in the
1926 second column, and click Add Release. You will then need to create a new
1927 release for your package, using the format of $VERSION ($CODE_STATUS), e.g.
1930 Now just follow the prompts. Be sure to add any appropriate Release notes. You
1931 should see your freshly uploaded packages in "Step 2. Add Files To This
1932 Release". Check the appropriate box(es). Remember at each step to hit the
1933 "Refresh/Submit" buttons! You should now see your file(s) listed in Step 3.
1934 Fill out the forms with the appropriate information for your platform, being
1935 sure to hit "Update" for each file. If anyone is monitoring your platform,
1936 check the "email" box at the very bottom to notify them of the new package.
1939 If you have made errors, or need to make changes, you can go through
1940 essentially the same steps, but select Edit Release, instead of Add Release.
1941 -------------------------------------------------------------------------------
1943 6.5. After the Release
1945 When all (or: most of the) packages have been uploaded and made available, send
1946 an email to the announce mailing list, Subject: "Version X.Y.Z available for
1947 download". Be sure to include the download location, the release notes and the
1949 -------------------------------------------------------------------------------
1951 7. Update the Webserver
1953 When updating the webserver, please follow these steps to make sure that no
1954 broken links, inconsistent contents or permission problems will occur:
1956 If you have changed anything in the documentation source SGML files, do:
1958 make dok # (or make redhat-dok if make dok doesn't work for you)
1960 That will generate doc/webserver/user-manual, doc/webserver/developer-manual,
1961 doc/webserver/faq and doc/webserver/index.html automatically.
1963 If you changed the manual page source, generate doc/webserver/man-page/
1964 privoxy-man-page.html by running "make man". (This is a separate target due to
1965 dependencies on some obscure perl scripts. See comments in GNUmakefile.)
1967 If you want to add new files to the webserver, create them locally in the doc/
1968 webserver/* directory (or create new directories under doc/webserver).
1970 Next, commit any changes from the above steps to CVS. All set? Then do
1974 This will do the upload to the webserver (www.privoxy.org) and ensure all files
1975 and directories there are group writable.
1977 Please do NOT use any other means of transferring files to the webserver to
1978 avoid permission problems.
1979 -------------------------------------------------------------------------------
1981 8. Contacting the developers, Bug Reporting and Feature Requests
1983 We value your feedback. In fact, we rely on it to improve Privoxy and its
1984 configuration. However, please note the following hints, so we can provide you
1985 with the best support:
1986 -------------------------------------------------------------------------------
1990 For casual users, our support forum at SourceForge is probably best suited:
1991 http://sourceforge.net/tracker/?group_id=11118&atid=211118
1993 All users are of course welcome to discuss their issues on the users mailing
1994 list, where the developers also hang around.
1995 -------------------------------------------------------------------------------
1999 Please report all bugs only through our bug tracker: http://sourceforge.net/
2000 tracker/?group_id=11118&atid=111118.
2002 Before doing so, please make sure that the bug has not already been submitted
2003 and observe the additional hints at the top of the submit form.
2005 Please try to verify that it is a Privoxy bug, and not a browser or site bug
2006 first. If unsure, try toggling off Privoxy, and see if the problem persists.
2007 The appendix of the user manual also has helpful information on action
2008 debugging. If you are using your own custom configuration, please try the stock
2009 configs to see if the problem is configuration related.
2011 If not using the latest version, chances are that the bug has been found and
2012 fixed in the meantime. We would appreciate if you could take the time to
2013 upgrade to the latest version (or even the latest CVS snapshot) and verify your
2014 bug, but this is not required for reporting.
2015 -------------------------------------------------------------------------------
2017 8.3. Request New Features
2019 You are welcome to submit ideas on new features or other proposals for
2020 improvement through our feature request tracker at http://sourceforge.net/
2021 tracker/?atid=361118&group_id=11118.
2022 -------------------------------------------------------------------------------
2024 8.4. Report Ads or Other Actions-Related Problems
2026 Please send feedback on ads that slipped through, innocent images that were
2027 blocked, and any other problems relating to the default.action file through our
2028 actions feedback mechanism located at http://www.privoxy.org/actions/. On this
2029 page, you will also find a bookmark which will take you back there from any
2030 troubled site and even pre-fill the form!
2032 New, improved default.action files will occasionally be made available based on
2033 your feedback. These will be announced on the ijbswa-announce list and
2034 available from our the files section of our project page.
2035 -------------------------------------------------------------------------------
2039 For any other issues, feel free to use the mailing lists. Technically
2040 interested users and people who wish to contribute to the project are also
2041 welcome on the developers list! You can find an overview of all Privoxy-related
2042 mailing lists, including list archives, at: http://sourceforge.net/mail/?
2044 -------------------------------------------------------------------------------
2046 9. Privoxy Copyright, License and History
2048 Copyright © 2001, 2002 by Privoxy Developers <developers@privoxy.org>
2050 Some source code is based on code Copyright © 1997 by Anonymous Coders and
2051 Junkbusters, Inc. and licensed under the GNU General Public License.
2052 -------------------------------------------------------------------------------
2056 Privoxy is free software; you can redistribute it and/or modify it under the
2057 terms of the GNU General Public License, version 2, as published by the Free
2058 Software Foundation.
2060 This program is distributed in the hope that it will be useful, but WITHOUT ANY
2061 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
2062 PARTICULAR PURPOSE. See the GNU General Public License for more details, which
2063 is available from the Free Software Foundation, Inc, 59 Temple Place - Suite
2064 330, Boston, MA 02111-1307, USA.
2066 You should have received a copy of the GNU General Public License along with
2067 this program; if not, write to the
2070 Foundation, Inc. 59 Temple Place - Suite 330
2071 Boston, MA 02111-1307
2073 -------------------------------------------------------------------------------
2077 In the beginning, there was the Internet Junkbuster, by Anonymous Coders and
2078 Junkbusters Corporation. It saved many users a lot of pain in the early days of
2079 web advertising and user tracking.
2081 But the web, its protocols and standards, and with it, the techniques for
2082 forcing users to consume ads, give up autonomy over their browsing, and for
2083 spying on them, kept evolving. Unfortunately, the Internet Junkbuster did not.
2084 Version 2.0.2, published in 1998, was (and is) the last official release
2085 available from Junkbusters Corporation. Fortunately, it had been released under
2086 the GNU GPL, which allowed further development by others.
2088 So Stefan Waldherr started maintaining an improved version of the software, to
2089 which eventually a number of people contributed patches. It could already
2090 replace banners with a transparent image, and had a first version of pop-up
2091 killing, but it was still very closely based on the original, with all its
2092 limitations, such as the lack of HTTP/1.1 support, flexible per-site
2093 configuration, or content modification. The last release from this effort was
2094 version 2.0.2-10, published in 2000.
2096 Then, some developers picked up the thread, and started turning the software
2097 inside out, upside down, and then reassembled it, adding many new features
2100 The result of this is Privoxy, whose first stable release, 3.0, is due late
2101 summer or early fall 2002.
2102 -------------------------------------------------------------------------------
2106 Other references and sites of interest to Privoxy users:
2108 http://www.privoxy.org/, the Privoxy Home page.
2110 http://www.privoxy.org/faq/, the Privoxy FAQ.
2112 http://sourceforge.net/projects/ijbswa/, the Project Page for Privoxy on
2115 http://config.privoxy.org/, the web-based user interface. Privoxy must be
2116 running for this to work. Shortcut: http://p.p/
2118 http://www.privoxy.org/actions/, to submit "misses" to the developers.
2120 http://www.junkbusters.com/ht/en/cookies.html, an explanation how cookies are
2121 used to track web users.
2123 http://www.junkbusters.com/ijb.html, the original Internet Junkbuster.
2125 http://www.waldherr.org/junkbuster/, Stefan Waldherr's version of Junkbuster,
2126 from which Privoxy was derived.
2128 http://privacy.net/analyze/, a useful site to check what information about you
2129 is leaked while you browse the web.
2131 http://www.squid-cache.org/, a very popular caching proxy, which is often used
2132 together with Privoxy.
2134 http://www.privoxy.org/developer-manual/, the Privoxy developer manual.