1 Privoxy Developer Manual
3 Copyright © 2001, 2002 by Privoxy Developers
5 $Id: developer-manual.sgml,v 1.46.2.8 2002/08/17 00:16:10 hal9 Exp $
7 The developer manual provides guidance on coding, testing, packaging,
8 documentation and other issues of importance to those involved with Privoxy
9 development. It is mandatory (and helpful!) reading for anyone who wants to
12 Please note that this document is constantly evolving. This copy represents the
13 state at the release of version 3.0.0. You can find the latest version of the
14 this manual at http://www.privoxy.org/developer-manual/. Please see the Contact
15 section on how to contact the developers.
17 -------------------------------------------------------------------------------
22 1.1. Quickstart to Privoxy Development
27 2.2. CVS Commit Guideline
28 2.3. Discussing Changes First
30 3. Documentation Guidelines
32 3.1. Quickstart to Docbook and SGML
33 3.2. Privoxy Documentation Style
34 3.3. Privoxy Custom Entities
41 4.2.1. Comment, Comment, Comment
42 4.2.2. Use blocks for comments
43 4.2.3. Keep Comments on their own line
44 4.2.4. Comment each logical step
45 4.2.5. Comment All Functions Thoroughly
46 4.2.6. Comment at the end of braces if the content is more than one
49 4.3. Naming Conventions
53 4.3.3. Header file prototypes
54 4.3.4. Enumerations, and #defines
59 4.4.1. Put braces on a line by themselves.
60 4.4.2. ALL control statements should have a block
61 4.4.3. Do not belabor/blow-up boolean expressions
62 4.4.4. Use white space freely because it is free
63 4.4.5. Don't use white space around structure operators
64 4.4.6. Make the last brace of a function stand out
65 4.4.7. Use 3 character indentions
69 4.5.1. Initialize all variables
73 4.6.1. Name functions that return a boolean as a question.
74 4.6.2. Always specify a return type for a function.
75 4.6.3. Minimize function calls when iterating by using variables
76 4.6.4. Pass and Return by Const Reference
77 4.6.5. Pass and Return by Value
78 4.6.6. Names of include files
79 4.6.7. Provide multiple inclusion protection
80 4.6.8. Use `extern "C"` when appropriate
81 4.6.9. Where Possible, Use Forward Struct Declaration Instead of
84 4.7. General Coding Practices
86 4.7.1. Turn on warnings
87 4.7.2. Provide a default case for all switch statements
88 4.7.3. Try to avoid falling through cases in a switch statement.
89 4.7.4. Use 'long' or 'short' Instead of 'int'
90 4.7.5. Don't mix size_t and other types
91 4.7.6. Declare each variable and struct on its own line.
92 4.7.7. Use malloc/zalloc sparingly
93 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
95 4.7.9. Add loaders to the `file_list' structure and in order
96 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
98 4.8. Addendum: Template for files and function comment blocks:
100 5. Testing Guidelines
102 5.1. Testplan for releases
105 6. Releasing a New Version
108 6.2. Before the Release: Freeze
109 6.3. Building and Releasing the Packages
111 6.3.1. Note on Privoxy Packaging
112 6.3.2. Source Tarball
113 6.3.3. SuSE, Conectiva or Red Hat RPM
124 6.4. Uploading and Releasing Your Package
125 6.5. After the Release
127 7. Update the Webserver
128 8. Contacting the developers, Bug Reporting and Feature Requests
132 8.3. Request New Features
133 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.
154 -------------------------------------------------------------------------------
156 1.1. Quickstart to Privoxy Development
158 You'll need an account on Sourceforge to support our development. Mail your ID
159 to the list and wait until a project manager has added you.
161 For the time being (read, this section is under construction), please refer to
162 the extensive comments in the source code.
164 -------------------------------------------------------------------------------
166 2. The CVS Repository
168 If you intend to help us with programming, documentation or packaging you will
169 need write access to our holy grail, the CVS repository. Please read this
170 chapter completely before accessing via CVS.
172 -------------------------------------------------------------------------------
176 The project's CVS repository is hosted on SourceForge. Please refer to the
177 chapters 6 and 7 in SF's site documentation for the technical access details
178 for your operating system. For historical reasons, the CVS server is called
179 cvs.ijbswa.sourceforge.net, the repository is called ijbswa, and the source
180 tree module is called current.
182 -------------------------------------------------------------------------------
184 2.2. CVS Commit Guideline
186 The source tree is the heart of every software project. Every effort must be
187 made to ensure that it is readable, compilable and consistent at all times. We
188 therefore ask anyone with CVS access to strictly adhere to the following
191 * Never (read: never, ever) be tempted to commit that small change without
192 testing it thoroughly first. When we're close to a public release, ask a
193 fellow developer to review your changes.
195 * Your commit message should give a concise overview of what you changed (no
196 big details) and why you changed it Just check previous messages for good
199 * Don't use the same message on multiple files, unless it equally applies to
202 * If your changes span multiple files, and the code won't recompile unless
203 all changes are committed (e.g. when changing the signature of a function),
204 then commit all files one after another, without long delays in between. If
205 necessary, prepare the commit messages in advance.
207 * Before changing things on CVS, make sure that your changes are in line with
208 the team's general consensus on what should be done (see below).
210 * Don't commit into the stable branch, unless immediately before a new
211 release. (See Version Numbers below for details.) Collect your changes on
212 the patches tracker instead.
214 -------------------------------------------------------------------------------
216 2.3. Discussing Changes First
218 We don't have a too formal policy on this, just use common sense. Hints: If it
221 1. ..a bug-fix / clean-up / cosmetic thing: shoot
223 2. ..a new feature that can be turned off: shoot
225 3. ..a clear improvement w/o side effects on other parts of the code: shoot
227 4. ..a matter of taste: ask the list
229 5. ..a major redesign of some part of the code: ask the list
231 Note that near a major public release, we get a bit more cautious - if unsure,
232 it doesn't hurt to ask first. There is always the possibility to submit a patch
233 to the patches tracker instead.
235 -------------------------------------------------------------------------------
237 3. Documentation Guidelines
239 All formal documents are maintained in Docbook SGML and located in the doc/
240 source/* directory. You will need Docbook, the Docbook DTD's and the Docbook
241 modular stylesheets (or comparable alternatives), and either jade or openjade
242 (recommended) installed in order to build docs from source. Currently there is
243 user-manual, FAQ, and, of course this, the developer-manual in this format. The
244 README, AUTHORS privoxy.1 (man page), and config files are also now maintained
245 as Docbook SGML. These files, when built, in the top-level source directory are
246 generated files! Also, the Privoxy index.html (and a variation on this file,
247 privoxy-index.html, meant for inclusion with doc packages), are maintained as
248 SGML as well. DO NOT edit these directly. Edit the SGML source, or contact
249 someone involved in the documentation (at present Hal).
251 config requires some special handling. The reason it is maintained this way is
252 so that the extensive comments in the file mirror those in user-manual. But the
253 conversion process requires going from SGML to HTML to text to special
254 formatting required for the embedded comments. Some of this does not survive so
255 well. Especially some of the examples that are longer than 80 characters. The
256 build process for this file outputs to config.new, which should be reviewed for
257 errors and mis-formatting. Once satisfied that it is correct, then it should be
258 hand copied to config.
260 Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain
261 text files in the top-level source directory. At least for the time being.
263 Packagers are encouraged to include this documentation. For those without the
264 ability to build the docs locally, text versions of each are kept in CVS. HTML
265 versions are also now being kept in CVS under doc/webserver/*.
267 Formal documents are built with the Makefile targets of make dok, or
268 alternately make redhat-dok. If you have problems, try both. The build process
269 uses the document SGML sources in doc/source/*/* to update all text files in
270 doc/text/ and to update all HTML documents in doc/webserver/.
272 Documentation writers should please make sure documents build successfully
273 before committing to CVS, if possible.
275 How do you update the webserver (i.e. the pages on privoxy.org)?
277 1. First, build the docs by running make dok (or alternately make redhat-dok).
278 For PDF docs, do make dok-pdf.
280 2. Run make webserver which copies all files from doc/webserver to the
281 sourceforge webserver via scp.
283 Finished docs should be occasionally submitted to CVS (doc/webserver/*/*.html)
284 so that those without the ability to build them locally, have access to them if
285 needed. This is especially important just prior to a new release! Please do
286 this after the $VERSION and other release specific data in configure.in has
287 been updated (this is done just prior to a new release).
289 -------------------------------------------------------------------------------
291 3.1. Quickstart to Docbook and SGML
293 If you are not familiar with SGML, it is a markup language similar to HTML.
294 Actually, not a mark up language per se, but a language used to define markup
295 languages. In fact, HTML is an SGML application. Both will use "tags" to format
296 text and other content. SGML tags can be much more varied, and flexible, but do
297 much of the same kinds of things. The tags, or "elements", are definable in
298 SGML. There is no set "standards". Since we are using Docbook, our tags are
299 those that are defined by Docbook. Much of how the finish document is rendered
300 is determined by the "stylesheets". The stylesheets determine how each tag gets
301 translated to HTML, or other formats.
303 Tags in Docbook SGML need to be always "closed". If not, you will likely
304 generate errors. Example: <title>My Title</title>. They are also
305 case-insensitive, but we strongly suggest using all lower case. This keeps
306 compatibility with [Docbook] XML.
308 Our documents use "sections" for the most part. Sections will be processed into
309 HTML headers (e.g. h1 for sect1). The Docbook stylesheets will use these to
310 also generate the Table of Contents for each doc. Our TOC's are set to a depth
311 of three. Meaning sect1, sect2, and sect3 will have TOC entries, but sect4 will
312 not. Each section requires a <title> element, and at least one <para>. There is
313 a limit of five section levels in Docbook, but generally three should be
314 sufficient for our purposes.
316 Some common elements that you likely will use:
318 <para></para>, paragraph delimiter. Most text needs to be within paragraph
319 elements (there are some exceptions).
320 <emphasis></emphasis>, the stylesheets make this italics.
321 <filename></filename>, files and directories.
322 <command></command>, command examples.
323 <literallayout></literallayout>, like <pre>, more or less.
324 <itemizedlist></itemizedlist>, list with bullets.
325 <listitem></listitem>, member of the above.
326 <screen></screen>, screen output, implies <literallayout>.
327 <ulink url="example.com"></ulink>, like HTML <a> tag.
328 <quote></quote>, for, doh, quoting text.
330 Look at any of the existing docs for examples of all these and more.
332 You might also find "Writing Documentation Using DocBook - A Crash Course"
335 -------------------------------------------------------------------------------
337 3.2. Privoxy Documentation Style
339 It will be easier if everyone follows a similar writing style. This just makes
340 it easier to read what someone else has written if it is all done in a similar
345 * All tags should be lower case.
347 * Tags delimiting a block of text (even small blocks) should be on their own
355 Tags marking individual words, or few words, should be in-line:
357 Just to <emphasis>emphasize</emphasis>, some text goes here.
360 * Tags should be nested and step indented for block text like: (except
367 Some text goes here in our list example.
374 This makes it easier to find the text amongst the tags ;-)
376 * Use white space to separate logical divisions within a document, like
377 between sections. Running everything together consistently makes it harder
380 * Do not hesitate to make comments. Comments can either use the <comment>
381 element, or the <!-- --> style comment familiar from HTML. (Note in Docbook
382 v4.x <comment> is replaced by <remark>.)
384 * We have an international audience. Refrain from slang, or English
385 idiosyncrasies (too many to list :). Humor also does not translate well
388 * Try to keep overall line lengths in source files to 80 characters or less
389 for obvious reasons. This is not always possible, with lengthy URLs for
392 * Our documents are available in differing formats. Right now, they are just
393 plain text, TML, and PDF, but others are always a future possibility. Be
394 careful with URLs (<ulink>), and avoid this mistake:
396 My favorite site is <ulink url="http://example.com">here</ulink>.
398 This will render as "My favorite site is here", which is not real helpful
399 in a text doc. Better like this:
401 My favorite site is <ulink url="http://example.com">example.com</ulink>.
403 * All documents should be spell checked occasionally. aspell can check SGML
404 with the -H option. (ispell I think too.)
406 -------------------------------------------------------------------------------
408 3.3. Privoxy Custom Entities
410 Privoxy documentation is using a number of customized "entities" to facilitate
411 documentation maintenance.
413 We are using a set of "boilerplate" files with generic text, that is used by
414 multiple docs. This way we can write something once, and use it repeatedly
415 without having to re-write the same content over and over again. If editing
416 such a file, keep in mind that it should be generic. That is the purpose; so it
417 can be used in varying contexts without additional modifications.
419 We are also using what Docbook calls "internal entities". These are like
420 variables in programming. Well, sort of. For instance, we have the p-version
421 entity that contains the current Privoxy version string. You are strongly
422 encouraged to use these where possible. Some of these obviously require
423 re-setting with each release (done by the Makefile). A sampling of custom
424 entities are listed below. See any of the main docs for examples.
426 * Re- "boilerplate" text entities are defined like:
428 <!entity supported SYSTEM "supported.sgml">
430 In this example, the contents of the file, supported.sgml is available for
431 inclusion anywhere in the doc. To make this happen, just reference the now
432 defined entity: &supported; (starts with an ampersand and ends with a
433 semi-colon), and the contents will be dumped into the finished doc at that
436 * Commonly used "internal entities":
438 p-version: the Privoxy version string, e.g. "3.0.0".
439 p-status: the project status, either "alpha", "beta", or "stable".
440 p-not-stable: use to conditionally include text in "not stable" releases
442 p-stable: just the opposite.
443 p-text: this doc is only generated as text.
445 There are others in various places that are defined for a specific purpose.
448 -------------------------------------------------------------------------------
454 This set of standards is designed to make our lives easier. It is developed
455 with the simple goal of helping us keep the "new and improved Privoxy"
456 consistent and reliable. Thus making maintenance easier and increasing chances
457 of success of the project.
459 And that of course comes back to us as individuals. If we can increase our
460 development and product efficiencies then we can solve more of the request for
461 changes/improvements and in general feel good about ourselves. ;->
463 -------------------------------------------------------------------------------
467 4.2.1. Comment, Comment, Comment
471 Comment as much as possible without commenting the obvious. For example do not
472 comment "aVariable is equal to bVariable". Instead explain why aVariable should
473 be equal to the bVariable. Just because a person can read code does not mean
474 they will understand why or what is being done. A reader may spend a lot more
475 time figuring out what is going on when a simple comment or explanation would
476 have prevented the extra research. Please help your brother IJB'ers out!
478 The comments will also help justify the intent of the code. If the comment
479 describes something different than what the code is doing then maybe a
480 programming error is occurring.
484 /* if page size greater than 1k ... */
485 if ( PageLength() > 1024 )
487 ... "block" the page up ...
490 /* if page size is small, send it in blocks */
491 if ( PageLength() > 1024 )
493 ... "block" the page up ...
496 This demonstrates 2 cases of "what not to do". The first is a
497 "syntax comment". The second is a comment that does not fit what
498 is actually being done.
500 -------------------------------------------------------------------------------
502 4.2.2. Use blocks for comments
506 Comments can help or they can clutter. They help when they are differentiated
507 from the code they describe. One line comments do not offer effective
508 separation between the comment and the code. Block identifiers do, by
509 surrounding the code with a clear, definable pattern.
513 /*********************************************************************
514 * This will stand out clearly in your code!
515 *********************************************************************/
516 if ( thisVariable == thatVariable )
518 DoSomethingVeryImportant();
522 /* unfortunately, this may not */
523 if ( thisVariable == thatVariable )
525 DoSomethingVeryImportant();
529 if ( thisVariable == thatVariable ) /* this may not either */
531 DoSomethingVeryImportant();
536 If you are trying to add a small logic comment and do not wish to "disrupt" the
537 flow of the code, feel free to use a 1 line comment which is NOT on the same
540 -------------------------------------------------------------------------------
542 4.2.3. Keep Comments on their own line
546 It goes back to the question of readability. If the comment is on the same line
547 as the code it will be harder to read than the comment that is on its own line.
549 There are three exceptions to this rule, which should be violated freely and
550 often: during the definition of variables, at the end of closing braces, when
551 used to comment parameters.
555 /*********************************************************************
556 * This will stand out clearly in your code,
557 * But the second example won't.
558 *********************************************************************/
559 if ( thisVariable == thatVariable )
561 DoSomethingVeryImportant();
564 if ( thisVariable == thatVariable ) /*can you see me?*/
566 DoSomethingVeryImportant(); /*not easily*/
570 /*********************************************************************
571 * But, the encouraged exceptions:
572 *********************************************************************/
573 int urls_read = 0; /* # of urls read + rejected */
574 int urls_rejected = 0; /* # of urls rejected */
578 DoSomethingVeryImportant();
582 short DoSomethingVeryImportant(
583 short firstparam, /* represents something */
584 short nextparam /* represents something else */ )
588 } /* -END- DoSomethingVeryImportant */
590 -------------------------------------------------------------------------------
592 4.2.4. Comment each logical step
596 Logical steps should be commented to help others follow the intent of the
597 written code and comments will make the code more readable.
599 If you have 25 lines of code without a comment, you should probably go back
600 into it to see where you forgot to put one.
602 Most "for", "while", "do", etc... loops _probably_ need a comment. After all,
603 these are usually major logic containers.
605 -------------------------------------------------------------------------------
607 4.2.5. Comment All Functions Thoroughly
611 A reader of the code should be able to look at the comments just prior to the
612 beginning of a function and discern the reason for its existence and the
613 consequences of using it. The reader should not have to read through the code
614 to determine if a given function is safe for a desired use. The proper
615 information thoroughly presented at the introduction of a function not only
616 saves time for subsequent maintenance or debugging, it more importantly aids in
617 code reuse by allowing a user to determine the safety and applicability of any
618 function for the problem at hand. As a result of such benefits, all functions
619 should contain the information presented in the addendum section of this
622 -------------------------------------------------------------------------------
624 4.2.6. Comment at the end of braces if the content is more than one screen
629 Each closing brace should be followed on the same line by a comment that
630 describes the origination of the brace if the original brace is off of the
631 screen, or otherwise far away from the closing brace. This will simplify the
632 debugging, maintenance, and readability of the code.
634 As a suggestion , use the following flags to make the comment and its brace
637 use following a closing brace: } /* -END- if() or while () or etc... */
643 DoSomethingVeryImportant();
644 ...some long list of commands...
645 } /* -END- if x is 1 */
651 DoSomethingVeryImportant();
652 ...some long list of commands...
653 } /* -END- if ( 1 == X ) */
655 -------------------------------------------------------------------------------
657 4.3. Naming Conventions
659 4.3.1. Variable Names
663 Use all lowercase, and separate words via an underscore ('_'). Do not start an
664 identifier with an underscore. (ANSI C reserves these for use by the compiler
665 and system headers.) Do not use identifiers which are reserved in ANSI C++.
666 (E.g. template, class, true, false, ...). This is in case we ever decide to
671 int ms_iis5_hack = 0;
675 int msiis5hack = 0; int msIis5Hack = 0;
677 -------------------------------------------------------------------------------
679 4.3.2. Function Names
683 Use all lowercase, and separate words via an underscore ('_'). Do not start an
684 identifier with an underscore. (ANSI C reserves these for use by the compiler
685 and system headers.) Do not use identifiers which are reserved in ANSI C++.
686 (E.g. template, class, true, false, ...). This is in case we ever decide to
691 int load_some_file( struct client_state *csp )
695 int loadsomefile( struct client_state *csp )
696 int loadSomeFile( struct client_state *csp )
698 -------------------------------------------------------------------------------
700 4.3.3. Header file prototypes
704 Use a descriptive parameter name in the function prototype in header files. Use
705 the same parameter name in the header file that you use in the c file.
709 (.h) extern int load_aclfile( struct client_state *csp );
710 (.c) int load_aclfile( struct client_state *csp )
714 (.h) extern int load_aclfile( struct client_state * ); or
715 (.h) extern int load_aclfile();
716 (.c) int load_aclfile( struct client_state *csp )
718 -------------------------------------------------------------------------------
720 4.3.4. Enumerations, and #defines
724 Use all capital letters, with underscores between words. Do not start an
725 identifier with an underscore. (ANSI C reserves these for use by the compiler
730 (enumeration) : enum Boolean { FALSE, TRUE };
731 (#define) : #define DEFAULT_SIZE 100;
733 Note: We have a standard naming scheme for #defines that toggle a feature in
734 the preprocessor: FEATURE_>, where > is a short (preferably 1 or 2 word)
739 #define FEATURE_FORCE 1
742 #define FORCE_PREFIX blah
743 #endif /* def FEATURE_FORCE */
745 -------------------------------------------------------------------------------
751 Spell common words out entirely (do not remove vowels).
753 Use only widely-known domain acronyms and abbreviations. Capitalize all letters
756 Use underscore (_) to separate adjacent acronyms and abbreviations. Never
757 terminate a name with an underscore.
761 #define USE_IMAGE_LIST 1
765 #define USE_IMG_LST 1 or
766 #define _USE_IMAGE_LIST 1 or
767 #define USE_IMAGE_LIST_ 1 or
768 #define use_image_list 1 or
769 #define UseImageList 1
771 -------------------------------------------------------------------------------
775 4.4.1. Put braces on a line by themselves.
779 The brace needs to be on a line all by itself, not at the end of the statement.
780 Curly braces should line up with the construct that they're associated with.
781 This practice makes it easier to identify the opening and closing braces for a
793 if ( this == that ) { ... }
797 if ( this == that ) { ... }
799 Note: In the special case that the if-statement is inside a loop, and it is
800 trivial, i.e. it tests for a condition that is obvious from the purpose of the
801 block, one-liners as above may optically preserve the loop structure and make
804 Status: developer-discretion.
808 while ( more lines are read )
810 /* Please document what is/is not a comment line here */
811 if ( it's a comment ) continue;
813 do_something( line );
816 -------------------------------------------------------------------------------
818 4.4.2. ALL control statements should have a block
822 Using braces to make a block will make your code more readable and less prone
823 to error. All control statements should have a block defined.
835 if ( this == that ) DoSomething(); DoSomethingElse();
839 if ( this == that ) DoSomething();
841 Note: The first example in "Instead of" will execute in a manner other than
842 that which the developer desired (per indentation). Using code braces would
843 have prevented this "feature". The "explanation" and "exception" from the point
846 -------------------------------------------------------------------------------
848 4.4.3. Do not belabor/blow-up boolean expressions
852 structure->flag = ( condition );
856 if ( condition ) { structure->flag = 1; } else { structure->flag = 0; }
858 Note: The former is readable and concise. The later is wordy and inefficient.
859 Please assume that any developer new to the project has at least a "good"
860 knowledge of C/C++. (Hope I do not offend by that last comment ... 8-)
862 -------------------------------------------------------------------------------
864 4.4.4. Use white space freely because it is free
868 Make it readable. The notable exception to using white space freely is listed
869 in the next guideline.
875 int anotherValue = 0;
876 int thisVariable = 0;
878 if ( thisVariable == thatVariable )
880 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
882 -------------------------------------------------------------------------------
884 4.4.5. Don't use white space around structure operators
888 - structure pointer operator ( "->" ) - member operator ( "." ) - functions and
891 It is a general coding practice to put pointers, references, and function
892 parentheses next to names. With spaces, the connection between the object and
893 variable/function name is not as clear.
901 Instead of: aStruct -> aMember; aStruct . aMember; FunctionName ();
903 -------------------------------------------------------------------------------
905 4.4.6. Make the last brace of a function stand out
914 } /* -END- function1 */
919 } /* -END- function2 */
923 int function1( ... ) { ...code... return( retCode ); } int function2( ... ) { }
925 Note: Use 1 blank line before the closing brace and 2 lines afterward. This
926 makes the end of function standout to the most casual viewer. Although function
927 comments help separate functions, this is still a good coding practice. In
928 fact, I follow these rules when using blocks in "for", "while", "do" loops, and
929 long if {} statements too. After all whitespace is free!
931 Status: developer-discretion on the number of blank lines. Enforced is the end
932 of function comments.
934 -------------------------------------------------------------------------------
936 4.4.7. Use 3 character indentions
940 If some use 8 character TABs and some use 3 character TABs, the code can look *
941 very* ragged. So use 3 character indentions only. If you like to use TABs, pass
942 your code through a filter such as "expand -t3" before checking in your code.
946 static const char * const url_code_map[256] =
956 return( ALWAYS_TRUE );
960 return( HOW_DID_YOU_GET_HERE );
963 return( NEVER_GETS_HERE );
967 -------------------------------------------------------------------------------
971 4.5.1. Initialize all variables
975 Do not assume that the variables declared will not be used until after they
976 have been assigned a value somewhere else in the code. Remove the chance of
977 accidentally using an unassigned variable.
985 Note: It is much easier to debug a SIGSEGV if the message says you are trying
986 to access memory address 00000000 and not 129FA012; or arrayPtr[20] causes a
987 SIGSEV vs. arrayPtr[0].
989 Status: developer-discretion if and only if the variable is assigned a value
990 "shortly after" declaration.
992 -------------------------------------------------------------------------------
996 4.6.1. Name functions that return a boolean as a question.
1000 Value should be phrased as a question that would logically be answered as a
1001 true or false statement
1005 ShouldWeBlockThis();
1009 -------------------------------------------------------------------------------
1011 4.6.2. Always specify a return type for a function.
1015 The default return for a function is an int. To avoid ambiguity, create a
1016 return for a function when the return has a purpose, and create a void return
1017 type if the function does not need to return anything.
1019 -------------------------------------------------------------------------------
1021 4.6.3. Minimize function calls when iterating by using variables
1025 It is easy to write the following code, and a clear argument can be made that
1026 the code is easy to understand:
1030 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
1035 Note: Unfortunately, this makes a function call for each and every iteration.
1036 This increases the overhead in the program, because the compiler has to look up
1037 the function each time, call it, and return a value. Depending on what occurs
1038 in the blockListLength() call, it might even be creating and destroying
1039 structures with each iteration, even though in each case it is comparing "cnt"
1040 to the same value, over and over. Remember too - even a call to blockListLength
1041 () is a function call, with the same overhead.
1043 Instead of using a function call during the iterations, assign the value to a
1044 variable, and evaluate using the variable.
1048 size_t len = blockListLength();
1050 for ( size_t cnt = 0; cnt < len; cnt ++ )
1055 Exceptions: if the value of blockListLength() *may* change or could *
1056 potentially* change, then you must code the function call in the for/while
1059 -------------------------------------------------------------------------------
1061 4.6.4. Pass and Return by Const Reference
1065 This allows a developer to define a const pointer and call your function. If
1066 your function does not have the const keyword, we may not be able to use your
1067 function. Consider strcmp, if it were defined as: extern int strcmp( char *s1,
1070 I could then not use it to compare argv's in main: int main( int argc, const
1071 char *argv[] ) { strcmp( argv[0], "privoxy" ); }
1073 Both these pointers are *const*! If the c runtime library maintainers do it, we
1076 -------------------------------------------------------------------------------
1078 4.6.5. Pass and Return by Value
1082 Most structures cannot fit onto a normal stack entry (i.e. they are not 4 bytes
1083 or less). Aka, a function declaration like: int load_aclfile( struct
1086 would not work. So, to be consistent, we should declare all prototypes with
1087 "pass by value": int load_aclfile( struct client_state *csp )
1089 -------------------------------------------------------------------------------
1091 4.6.6. Names of include files
1095 Your include statements should contain the file name without a path. The path
1096 should be listed in the Makefile, using -I as processor directive to search the
1097 indicated paths. An exception to this would be for some proprietary software
1098 that utilizes a partial path to distinguish their header files from system or
1103 #include <iostream.h> /* This is not a local include */
1104 #include "config.h" /* This IS a local include */
1108 /* This is not a local include, but requires a path element. */
1109 #include <sys/fileName.h>
1111 Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
1112 This duplicates the #include "file.h" behavior.
1114 -------------------------------------------------------------------------------
1116 4.6.7. Provide multiple inclusion protection
1120 Prevents compiler and linker errors resulting from redefinition of items.
1122 Wrap each header file with the following syntax to prevent multiple inclusions
1123 of the file. Of course, replace PROJECT_H with your file name, with "." Changed
1124 to "_", and make it uppercase.
1128 #ifndef PROJECT_H_INCLUDED
1129 #define PROJECT_H_INCLUDED
1131 #endif /* ndef PROJECT_H_INCLUDED */
1133 -------------------------------------------------------------------------------
1135 4.6.8. Use `extern "C"` when appropriate
1139 If our headers are included from C++, they must declare our functions as
1140 `extern "C"`. This has no cost in C, but increases the potential re-usability
1148 #endif /* def __cplusplus */
1150 ... function definitions here ...
1154 #endif /* def __cplusplus */
1156 -------------------------------------------------------------------------------
1158 4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
1162 Useful in headers that include pointers to other struct's. Modifications to
1163 excess header files may cause needless compiles.
1167 /*********************************************************************
1168 * We're avoiding an include statement here!
1169 *********************************************************************/
1171 extern file_list *xyz;
1173 Note: If you declare "file_list xyz;" (without the pointer), then including the
1174 proper header file is necessary. If you only want to prototype a pointer,
1175 however, the header file is unnecessary.
1177 Status: Use with discretion.
1179 -------------------------------------------------------------------------------
1181 4.7. General Coding Practices
1183 4.7.1. Turn on warnings
1187 Compiler warnings are meant to help you find bugs. You should turn on as many
1188 as possible. With GCC, the switch is "-Wall". Try and fix as many warnings as
1191 -------------------------------------------------------------------------------
1193 4.7.2. Provide a default case for all switch statements
1197 What you think is guaranteed is never really guaranteed. The value that you
1198 don't think you need to check is the one that someday will be passed. So, to
1199 protect yourself from the unknown, always have a default step in a switch
1204 switch( hash_string( cmd ) )
1206 case hash_actions_file :
1216 ... anomaly code goes here ...
1217 continue; / break; / exit( 1 ); / etc ...
1219 } /* end switch( hash_string( cmd ) ) */
1221 Note: If you already have a default condition, you are obviously exempt from
1222 this point. Of note, most of the WIN32 code calls `DefWindowProc' after the
1223 switch statement. This API call *should* be included in a default statement.
1225 Another Note: This is not so much a readability issue as a robust programming
1226 issue. The "anomaly code goes here" may be no more than a print to the STDERR
1227 stream (as in load_config). Or it may really be an ABEND condition.
1229 Status: Programmer discretion is advised.
1231 -------------------------------------------------------------------------------
1233 4.7.3. Try to avoid falling through cases in a switch statement.
1237 In general, you will want to have a 'break' statement within each 'case' of a
1238 switch statement. This allows for the code to be more readable and
1239 understandable, and furthermore can prevent unwanted surprises if someone else
1240 later gets creative and moves the code around.
1242 The language allows you to plan the fall through from one case statement to
1243 another simply by omitting the break statement within the case statement. This
1244 feature does have benefits, but should only be used in rare cases. In general,
1245 use a break statement for each case statement.
1247 If you choose to allow fall through, you should comment both the fact of the
1248 fall through and reason why you felt it was necessary.
1250 -------------------------------------------------------------------------------
1252 4.7.4. Use 'long' or 'short' Instead of 'int'
1256 On 32-bit platforms, int usually has the range of long. On 16-bit platforms,
1257 int has the range of short.
1259 Status: open-to-debate. In the case of most FSF projects (including X/
1260 GNU-Emacs), there are typedefs to int4, int8, int16, (or equivalence ... I
1261 forget the exact typedefs now). Should we add these to IJB now that we have a
1264 -------------------------------------------------------------------------------
1266 4.7.5. Don't mix size_t and other types
1270 The type of size_t varies across platforms. Do not make assumptions about
1271 whether it is signed or unsigned, or about how long it is. Do not compare a
1272 size_t against another variable of a different type (or even against a
1273 constant) without casting one of the values. Try to avoid using size_t if you
1276 -------------------------------------------------------------------------------
1278 4.7.6. Declare each variable and struct on its own line.
1282 It can be tempting to declare a series of variables all on one line. Don't.
1294 Explanation: - there is more room for comments on the individual variables -
1295 easier to add new variables without messing up the original ones - when
1296 searching on a variable to find its type, there is less clutter to "visually"
1299 Exceptions: when you want to declare a bunch of loop variables or other trivial
1300 variables; feel free to declare them on 1 line. You should, although, provide a
1301 good comment on their functions.
1303 Status: developer-discretion.
1305 -------------------------------------------------------------------------------
1307 4.7.7. Use malloc/zalloc sparingly
1311 Create a local struct (on the stack) if the variable will live and die within
1312 the context of one function call.
1314 Only "malloc" a struct (on the heap) if the variable's life will extend beyond
1315 the context of one function call.
1319 If a function creates a struct and stores a pointer to it in a
1320 list, then it should definitely be allocated via `malloc'.
1322 -------------------------------------------------------------------------------
1324 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
1328 If you have to "malloc" an instance, you are responsible for insuring that the
1329 instance is `free'd, even if the deallocation event falls within some other
1330 programmer's code. You are also responsible for ensuring that deletion is
1331 timely (i.e. not too soon, not too late). This is known as "low-coupling" and
1332 is a "good thing (tm)". You may need to offer a free/unload/destructor type
1333 function to accommodate this.
1337 int load_re_filterfile( struct client_state *csp ) { ... }
1338 static void unload_re_filterfile( void *f ) { ... }
1342 The developer cannot be expected to provide `free'ing functions for C run-time
1343 library functions ... such as `strdup'.
1345 Status: developer-discretion. The "main" use of this standard is for allocating
1346 and freeing data structures (complex or nested).
1348 -------------------------------------------------------------------------------
1350 4.7.9. Add loaders to the `file_list' structure and in order
1354 I have ordered all of the "blocker" file code to be in alpha order. It is
1355 easier to add/read new blockers when you expect a certain order.
1357 Note: It may appear that the alpha order is broken in places by POPUP tests
1358 coming before PCRS tests. But since POPUPs can also be referred to as
1359 KILLPOPUPs, it is clear that it should come first.
1361 -------------------------------------------------------------------------------
1363 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
1367 If you have enough confidence in new code or confidence in your changes, but
1368 are not *quite* sure of the repercussions, add this:
1370 /* FIXME: this code has a logic error on platform XYZ, * attempting to fix */ #
1371 ifdef PLATFORM ...changed code here... #endif
1375 /* FIXME: I think the original author really meant this... */ ...changed code
1380 /* FIXME: new code that *may* break something else... */ ...new code here...
1382 Note: If you make it clear that this may or may not be a "good thing (tm)", it
1383 will be easier to identify and include in the project (or conversely exclude
1386 -------------------------------------------------------------------------------
1388 4.8. Addendum: Template for files and function comment blocks:
1390 Example for file comments:
1392 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.8 2002/08/17 00:16:10 hal9 Exp $";
1393 /*********************************************************************
1397 * Purpose : (Fill me in with a good description!)
1399 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1400 * Privoxy team. http://www.privoxy.org/
1402 * Based on the Internet Junkbuster originally written
1403 * by and Copyright (C) 1997 Anonymous Coders and
1404 * Junkbusters Corporation. http://www.junkbusters.com
1406 * This program is free software; you can redistribute it
1407 * and/or modify it under the terms of the GNU General
1408 * Public License as published by the Free Software
1409 * Foundation; either version 2 of the License, or (at
1410 * your option) any later version.
1412 * This program is distributed in the hope that it will
1413 * be useful, but WITHOUT ANY WARRANTY; without even the
1414 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1415 * PARTICULAR PURPOSE. See the GNU General Public
1416 * License for more details.
1418 * The GNU General Public License should be included with
1419 * this file. If not, you can view it at
1420 * http://www.gnu.org/copyleft/gpl.html
1421 * or write to the Free Software Foundation, Inc., 59
1422 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1427 *********************************************************************/
1432 ...necessary include files for us to do our work...
1434 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1436 Note: This declares the rcs variables that should be added to the
1437 "show-proxy-args" page. If this is a brand new creation by you, you are free to
1438 change the "Copyright" section to represent the rights you wish to maintain.
1440 Note: The formfeed character that is present right after the comment flower box
1441 is handy for (X|GNU)Emacs users to skip the verbiage and get to the heart of
1442 the code (via `forward-page' and `backward-page'). Please include it if you
1445 Example for file header comments:
1449 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.8 2002/08/17 00:16:10 hal9 Exp $"
1450 /*********************************************************************
1454 * Purpose : (Fill me in with a good description!)
1456 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1457 * Privoxy team. http://www.privoxy.org/
1459 * Based on the Internet Junkbuster originally written
1460 * by and Copyright (C) 1997 Anonymous Coders and
1461 * Junkbusters Corporation. http://www.junkbusters.com
1463 * This program is free software; you can redistribute it
1464 * and/or modify it under the terms of the GNU General
1465 * Public License as published by the Free Software
1466 * Foundation; either version 2 of the License, or (at
1467 * your option) any later version.
1469 * This program is distributed in the hope that it will
1470 * be useful, but WITHOUT ANY WARRANTY; without even the
1471 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1472 * PARTICULAR PURPOSE. See the GNU General Public
1473 * License for more details.
1475 * The GNU General Public License should be included with
1476 * this file. If not, you can view it at
1477 * http://www.gnu.org/copyleft/gpl.html
1478 * or write to the Free Software Foundation, Inc., 59
1479 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1484 *********************************************************************/
1487 #include "project.h"
1493 ... function headers here ...
1496 /* Revision control strings from this header and associated .c file */
1497 extern const char FILENAME_rcs[];
1498 extern const char FILENAME_h_rcs[];
1505 #endif /* ndef _FILENAME_H */
1513 Example for function comments:
1515 /*********************************************************************
1517 * Function : FUNCTION_NAME
1519 * Description : (Fill me in with a good description!)
1522 * 1 : param1 = pointer to an important thing
1523 * 2 : x = pointer to something else
1525 * Returns : 0 => Ok, everything else is an error.
1527 *********************************************************************/
1528 int FUNCTION_NAME( void *param1, const char *x )
1535 Note: If we all follow this practice, we should be able to parse our code to
1536 create a "self-documenting" web page.
1538 -------------------------------------------------------------------------------
1540 5. Testing Guidelines
1544 -------------------------------------------------------------------------------
1546 5.1. Testplan for releases
1548 Explain release numbers. major, minor. developer releases. etc.
1550 1. Remove any existing rpm with rpm -e
1552 2. Remove any file that was left over. This includes (but is not limited to)
1560 + /etc/init.d/privoxy
1564 3. Install the rpm. Any error messages?
1566 4. start,stop,status Privoxy with the specific script (e.g. /etc/rc.d/init/
1567 privoxy stop). Reboot your machine. Does autostart work?
1569 5. Start browsing. Does Privoxy work? Logfile written?
1571 6. Remove the rpm. Any error messages? All files removed?
1573 -------------------------------------------------------------------------------
1577 Please submit test reports only with the test form at sourceforge. Three simple
1580 * Select category: the distribution you test on.
1582 * Select group: the version of Privoxy that we are about to release.
1584 * Fill the Summary and Detailed Description with something intelligent (keep
1585 it short and precise).
1587 Do not mail to the mailing list (we cannot keep track on issues there).
1589 -------------------------------------------------------------------------------
1591 6. Releasing a New Version
1593 When we release versions of Privoxy, our work leaves our cozy secret lab and
1594 has to work in the cold RealWorld[tm]. Once it is released, there is no way to
1595 call it back, so it is very important that great care is taken to ensure that
1596 everything runs fine, and not to introduce problems in the very last minute.
1598 So when releasing a new version, please adhere exactly to the procedure
1599 outlined in this chapter.
1601 The following programs are required to follow this process: ncftpput (ncftp),
1602 scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs.
1604 -------------------------------------------------------------------------------
1606 6.1. Version numbers
1608 First you need to determine which version number the release will have. Privoxy
1609 version numbers consist of three numbers, separated by dots, like in X.Y.Z,
1612 * X, the version major, is rarely ever changed. It is increased by one if
1613 turning a development branch into stable substantially changes the
1614 functionality, user interface or configuration syntax. Majors 1 and 2 were
1615 Junkbuster, and 3 will be the first stable Privoxy release.
1617 * Y, the version minor, represents the branch within the major version. At
1618 any point in time, there are two branches being maintained: The stable
1619 branch, with an even minor, say, 2N, in which no functionality is being
1620 added and only bug-fixes are made, and 2N+1, the development branch, in
1621 which the further development of Privoxy takes place. This enables us to
1622 turn the code upside down and inside out, while at the same time providing
1623 and maintaining a stable version. The minor is reset to zero (and one) when
1624 the major is incremented. When a development branch has matured to the
1625 point where it can be turned into stable, the old stable branch 2N is given
1626 up (i.e. no longer maintained), the former development branch 2N+1 becomes
1627 the new stable branch 2N+2, and a new development branch 2N+3 is opened.
1629 * Z, the point or sub version, represents a release of the software within a
1630 branch. It is therefore incremented immediately before each code freeze. In
1631 development branches, only the even point versions correspond to actual
1632 releases, while the odd ones denote the evolving state of the sources on
1633 CVS in between. It follows that Z is odd on CVS in development branches
1634 most of the time. There, it gets increased to an even number immediately
1635 before a code freeze, and is increased to an odd number again immediately
1636 thereafter. This ensures that builds from CVS snapshots are easily
1637 distinguished from released versions. The point version is reset to zero
1638 when the minor changes.
1640 -------------------------------------------------------------------------------
1642 6.2. Before the Release: Freeze
1644 The following must be done by one of the developers prior to each new release.
1646 * Make sure that everybody who has worked on the code in the last couple of
1647 days has had a chance to yell "no!" in case they have pending changes/fixes
1648 in their pipelines. Announce the freeze so that nobody will interfere with
1649 last minute changes.
1651 * Increment the version number (point from odd to even in development
1652 branches!) in configure.in. (RPM spec files will need to be incremented as
1655 * If default.action has changed since last release (i.e. software release or
1656 standalone actions file release), bump up its version info to A.B in this
1659 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
1661 Then change the version info in doc/webserver/actions/index.php, line:
1662 '$required_actions_file_version = "A.B";'
1664 * All documentation should be rebuild after the version bump. Finished docs
1665 should be then be committed to CVS (for those without the ability to build
1666 these). Some docs may require rather obscure processing tools. config, the
1667 man page (and the html version of the man page), and the PDF docs fall in
1668 this category. REAMDE, the man page, AUTHORS, and config should all also be
1669 committed to CVS for other packagers. The formal docs should be uploaded to
1670 the webserver. See the Section "Updating the webserver" in this manual for
1673 * The User Manual is also used for context sensitive help for the CGI editor.
1674 This is version sensitive, so that the user will get appropriate help for
1675 his/her release. So with each release a fresh version should be uploaded to
1676 the webserver (this is in addition to the main User Manual link from the
1677 main page since we need to keep manuals for various versions available).
1678 The CGI pages will link to something like http://privoxy.org/$(VERSION)/
1679 user-manual/. This will need to be updated for each new release. There is
1680 no Makefile target for this at this time!!! It needs to be done manually.
1682 * All developers should look at the ChangeLog and make sure noteworthy
1683 changes are referenced.
1685 * Commit all files that were changed in the above steps!
1687 * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
1688 use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
1690 * If the release was in a development branch, increase the point version from
1691 even to odd (X.Y.(Z+1)) again in configure.in and commit your change.
1693 * On the webserver, copy the user manual to a new top-level directory called
1694 X.Y.Z. This ensures that help links from the CGI pages, which have the
1695 version as a prefix, will go into the right version of the manual. If this
1696 is a development branch release, also symlink X.Y.(Z-1) to X.Y.Z and X.Y.
1697 (Z+1) to . (i.e. dot).
1699 -------------------------------------------------------------------------------
1701 6.3. Building and Releasing the Packages
1703 Now the individual packages can be built and released. Note that for GPL
1704 reasons the first package to be released is always the source tarball.
1706 For all types of packages, including the source tarball, you must make sure
1707 that you build from clean sources by exporting the right version from CVS into
1708 an empty directory (just press return when asked for a password):
1710 mkdir dist # delete or choose different name if it already exists
1712 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1713 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1715 Do NOT change a single bit, including, but not limited to version information
1716 after export from CVS. This is to make sure that all release packages, and with
1717 them, all future bug reports, are based on exactly the same code.
1719 Please find additional instructions for the source tarball and the individual
1720 platform dependent binary packages below. And details on the Sourceforge
1721 release process below that.
1723 -------------------------------------------------------------------------------
1725 6.3.1. Note on Privoxy Packaging
1727 Please keep these general guidelines in mind when putting together your
1728 package. These apply to all platforms!
1730 * Privoxy requires write access to: all *.action files, all logfiles, and the
1731 trust file. You will need to determine the best way to do this for your
1734 * Please include up to date documentation. At a bare minimum:
1736 LICENSE (top-level directory)
1738 README (top-level directory)
1740 AUTHORS (top-level directory)
1742 man page (top-level directory, Unix-like platforms only)
1744 The User Manual (doc/webserver/user-manual/)
1746 FAQ (doc/webserver/faq/)
1748 Also suggested: Developer Manual (doc/webserver/developer-manual) and
1749 ChangeLog (top-level directory). FAQ and the manuals are HTML docs. There
1750 are also text versions in doc/text/ which could conceivably also be
1753 The documentation has been designed such that the manuals are linked to
1754 each other from parallel directories, and should be packaged that way.
1755 privoxy-index.html can also be included and can serve as a focal point for
1756 docs and other links of interest (and possibly renamed to index.html). This
1757 should be one level up from the manuals. There is a link also on this page
1758 to an HTMLized version of the man page. To avoid 404 for this, it is in CVS
1759 as doc/webserver/man-page/privoxy-man-page.html, and should be included
1760 along with the manuals. There is also a css stylesheets that can be
1761 included for better presentation: p_doc.css. This should be in the same
1762 directory with privoxy-index.html, (i.e. one level up from the manual
1765 * user.action is designed for local preferences. Make sure this does not get
1768 * Other configuration files should be installed as the new defaults, but all
1769 previously installed configuration files should be preserved as backups.
1770 This is just good manners :-)
1772 * Please check platform specific notes in this doc, if you haven't done
1773 "Privoxy" packaging before for other platform specific issues. Conversely,
1774 please add any notes that you know are important for your platform (or
1775 contact one of the doc maintainers to do this if you can't).
1777 * Packagers should do a "clean" install of their package after building it.
1778 So any previous installs should be removed first to ensure the integrity of
1779 the newly built package. Then run the package for a while to make sure
1780 there are no obvious problems, before uploading.
1782 -------------------------------------------------------------------------------
1784 6.3.2. Source Tarball
1786 First, make sure that you have freshly exported the right version into an empty
1787 directory. (See "Building and releasing packages" above). Then run:
1790 autoheader && autoconf && ./configure
1796 To upload the package to Sourceforge, simply issue
1800 Go to the displayed URL and release the file publicly on Sourceforge. For the
1801 change log field, use the relevant section of the ChangeLog file.
1803 -------------------------------------------------------------------------------
1805 6.3.3. SuSE, Conectiva or Red Hat RPM
1807 In following text, replace dist with either "rh" for Red Hat or "suse" for
1810 First, make sure that you have freshly exported the right version into an empty
1811 directory. (See "Building and releasing packages" above).
1813 As the only exception to not changing anything after export from CVS, now
1814 examine the file privoxy-dist.spec and make sure that the version information
1815 and the RPM release number are correct. The RPM release numbers for each
1816 version start at one. Hence it must be reset to one if this is the first RPM
1817 for dist which is built from version X.Y.Z. Check the file list if unsure.
1818 Else, it must be set to the highest already available RPM release number for
1819 that version plus one.
1824 autoheader && autoconf && ./configure
1830 To upload the package to Sourceforge, simply issue
1832 make dist-upload rpm_packagerev
1834 where rpm_packagerev is the RPM release number as determined above. Go to the
1835 displayed URL and release the file publicly on Sourceforge. Use the release
1836 notes and change log from the source tarball package.
1838 -------------------------------------------------------------------------------
1842 First, make sure that you have freshly exported the right version into an empty
1843 directory. (See "Building and releasing packages" above). Then get the OS/2
1846 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
1848 You will need a mix of development tools. The main compilation takes place with
1849 IBM Visual Age C++. Some ancillary work takes place with GNU tools, available
1850 from various sources like hobbes.nmsu.edu. Specificially, you will need
1851 autoheader, autoconf and sh tools. The packaging takes place with WarpIN,
1852 available from various sources, including its home page: xworkplace.
1854 Change directory to the os2setup directory. Edit the os2build.cmd file to set
1855 the final executable filename. For example,
1857 installExeName='privoxyos2_setup_X.Y.Z.exe'
1859 Next, edit the IJB.wis file so the release number matches in the PACKAGEID
1862 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
1864 You're now ready to build. Run:
1868 You will find the WarpIN-installable executable in the ./files directory.
1869 Upload this anonymously to uploads.sourceforge.net/incoming, create a release
1870 for it, and you're done. Use the release notes and Change Log from the source
1873 -------------------------------------------------------------------------------
1877 Login to Sourceforge's compilefarm via ssh:
1879 ssh cf.sourceforge.net
1881 Choose the right operating system (not the Debian one). When logged in, make
1882 sure that you have freshly exported the right version into an empty directory.
1883 (See "Building and releasing packages" above). Then run:
1886 autoheader && autoconf && ./configure
1892 which creates a gzip'ed tar archive. Sadly, you cannot use make solaris-upload
1893 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1894 archive to Sourceforge's ftp server and release the file publicly. Use the
1895 release notes and Change Log from the source tarball package.
1897 -------------------------------------------------------------------------------
1901 You should ensure you have the latest version of Cygwin (from http://
1902 www.cygwin.com/). Run the following commands from within a Cygwin bash shell.
1904 First, make sure that you have freshly exported the right version into an empty
1905 directory. (See "Building and releasing packages" above). Then get the Windows
1908 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
1910 Then you can build the package. This is fully automated, and is controlled by
1911 winsetup/GNUmakefile. All you need to do is:
1916 Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
1917 upload it to SourceForge. When releasing the package on SourceForge, use the
1918 release notes and Change Log from the source tarball package.
1920 -------------------------------------------------------------------------------
1924 First, make sure that you have freshly exported the right version into an empty
1925 directory. (See "Building and releasing packages" above). Then add a log entry
1926 to debian/changelog, if it is not already there, for example by running:
1928 debchange -v 3.0.0-stable-1 "New upstream version"
1932 dpkg-buildpackage -rfakeroot -us -uc -b
1934 This will create ../privoxy_3.0.0-stable-1_i386.deb which can be uploaded. To
1935 upload the package to Sourceforge, simply issue
1939 -------------------------------------------------------------------------------
1943 First, make sure that you have freshly exported the right version into an empty
1944 directory. (See "Building and releasing packages" above). Then get the Mac OSX
1947 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
1954 This will run autoheader, autoconf and configure as well as make. Finally, it
1955 will copy over the necessary files to the ./osxsetup/files directory for
1956 further processing by PackageMaker.
1958 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the
1959 package name to match the release, and hit the "Create package" button. If you
1960 specify ./Privoxy.pkg as the output package name, you can then create the
1961 distributable zip file with the command:
1963 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
1965 You can then upload privoxyosx_setup_x.y.z.zip anonymously to
1966 uploads.sourceforge.net/incoming, create a release for it, and you're done. Use
1967 the release notes and Change Log from the source tarball package.
1969 -------------------------------------------------------------------------------
1973 Login to Sourceforge's compile-farm via ssh:
1975 ssh cf.sourceforge.net
1977 Choose the right operating system. When logged in, make sure that you have
1978 freshly exported the right version into an empty directory. (See "Building and
1979 releasing packages" above). Then run:
1982 autoheader && autoconf && ./configure
1988 which creates a gzip'ed tar archive. Sadly, you cannot use make freebsd-upload
1989 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1990 archive to Sourceforge's ftp server and release the file publicly. Use the
1991 release notes and Change Log from the source tarball package.
1993 -------------------------------------------------------------------------------
1997 First, make sure that you have freshly exported the right version into an empty
1998 directory. (See "Building and releasing packages" above). Then run:
2001 autoheader && autoconf && ./configure
2005 -------------------------------------------------------------------------------
2009 First, make sure that you have freshly exported the right version into an empty
2010 directory. (See "Building and releasing packages" above). Then run:
2013 autoheader && autoconf && ./configure
2017 -------------------------------------------------------------------------------
2021 Login to Sourceforge's compilefarm via ssh:
2023 ssh cf.sourceforge.net
2025 Choose the right operating system. When logged in, make sure that you have
2026 freshly exported the right version into an empty directory. (See "Building and
2027 releasing packages" above). Then run:
2030 autoheader && autoconf && ./configure
2036 which creates a gzip'ed tar archive. Sadly, you cannot use make aix-upload on
2037 the Sourceforge machine (no ncftpput). You now have to manually upload the
2038 archive to Sourceforge's ftp server and release the file publicly. Use the
2039 release notes and Change Log from the source tarball package.
2041 -------------------------------------------------------------------------------
2043 6.4. Uploading and Releasing Your Package
2045 After the package is ready, it is time to upload it to SourceForge, and go
2046 through the release steps. The upload is done via FTP:
2048 * Upload to: ftp://upload.sourceforge.net/incoming
2052 * password: ijbswa-developers@lists.sourceforge.net
2054 Or use the make targets as described above.
2056 Once this done go to http://sourceforge.net/project/admin/editpackages.php?
2057 group_id=11118, making sure you are logged in. Find your target platform in the
2058 second column, and click Add Release. You will then need to create a new
2059 release for your package, using the format of $VERSION ($CODE_STATUS), e.g.
2062 Now just follow the prompts. Be sure to add any appropriate Release notes. You
2063 should see your freshly uploaded packages in "Step 2. Add Files To This
2064 Release". Check the appropriate box(es). Remember at each step to hit the
2065 "Refresh/Submit" buttons! You should now see your file(s) listed in Step 3.
2066 Fill out the forms with the appropriate information for your platform, being
2067 sure to hit "Update" for each file. If anyone is monitoring your platform,
2068 check the "email" box at the very bottom to notify them of the new package.
2071 If you have made errors, or need to make changes, you can go through
2072 essentially the same steps, but select Edit Release, instead of Add Release.
2074 -------------------------------------------------------------------------------
2076 6.5. After the Release
2078 When all (or: most of the) packages have been uploaded and made available, send
2079 an email to the announce mailing list, Subject: "Version X.Y.Z available for
2080 download". Be sure to include the download location, the release notes and the
2081 Changelog. Also, post an updated News item on the project page Sourceforge, and
2082 update the Home page and docs linked from the Home page (see below).
2084 -------------------------------------------------------------------------------
2086 7. Update the Webserver
2088 The webserver should be updated at least with each stable release. When
2089 updating, please follow these steps to make sure that no broken links,
2090 inconsistent contents or permission problems will occur (as it has many times
2093 If you have changed anything in the stable-branch documentation source SGML
2096 make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
2098 That will generate doc/webserver/user-manual, doc/webserver/developer-manual,
2099 doc/webserver/faq, doc/pdf/*.pdf and doc/webserver/index.html automatically.
2101 If you changed the manual page sources, generate doc/webserver/man-page/
2102 privoxy-man-page.html by running "make man". (This is a separate target due to
2103 dependencies on some obscure perl scripts [now in CVS, but not well tested].
2104 See comments in GNUmakefile.)
2106 If you want to add new files to the webserver, create them locally in the doc/
2107 webserver/* directory (or create new directories under doc/webserver).
2109 Next, commit any changes from the above steps to CVS. All set? If these are
2110 docs in the stable branch, then do:
2114 This will do the upload to the webserver (www.privoxy.org) and ensure all files
2115 and directories there are group writable.
2117 Please do NOT use any other means of transferring files to the webserver to
2118 avoid permission problems. Also, please do not upload docs from development
2119 branches or versions. The publicly posted docs should be in sync with the last
2122 -------------------------------------------------------------------------------
2124 8. Contacting the developers, Bug Reporting and Feature Requests
2126 We value your feedback. In fact, we rely on it to improve Privoxy and its
2127 configuration. However, please note the following hints, so we can provide you
2128 with the best support:
2130 -------------------------------------------------------------------------------
2134 For casual users, our support forum at SourceForge is probably best suited:
2135 http://sourceforge.net/tracker/?group_id=11118&atid=211118
2137 All users are of course welcome to discuss their issues on the users mailing
2138 list, where the developers also hang around.
2140 -------------------------------------------------------------------------------
2144 Please report all bugs only through our bug tracker: http://sourceforge.net/
2145 tracker/?group_id=11118&atid=111118.
2147 Before doing so, please make sure that the bug has not already been submitted
2148 and observe the additional hints at the top of the submit form.
2150 Please try to verify that it is a Privoxy bug, and not a browser or site bug
2151 first. If unsure, try toggling off Privoxy, and see if the problem persists.
2152 The appendix of the user manual also has helpful information on action
2153 debugging. If you are using your own custom configuration, please try the stock
2154 configs to see if the problem is configuration related.
2156 If not using the latest version, chances are that the bug has been found and
2157 fixed in the meantime. We would appreciate if you could take the time to
2158 upgrade to the latest version (or even the latest CVS snapshot) and verify your
2159 bug, but this is not required for reporting.
2161 -------------------------------------------------------------------------------
2163 8.3. Request New Features
2165 You are welcome to submit ideas on new features or other proposals for
2166 improvement through our feature request tracker at http://sourceforge.net/
2167 tracker/?atid=361118&group_id=11118.
2169 -------------------------------------------------------------------------------
2171 8.4. Report Ads or Other Actions-Related Problems
2173 Please send feedback on ads that slipped through, innocent images that were
2174 blocked, and any other problems relating to the default.action file through our
2175 actions feedback mechanism located at http://www.privoxy.org/actions/. On this
2176 page, you will also find a bookmark which will take you back there from any
2177 troubled site and even pre-fill the form!
2179 New, improved default.action files will occasionally be made available based on
2180 your feedback. These will be announced on the ijbswa-announce list and
2181 available from our the files section of our project page.
2183 -------------------------------------------------------------------------------
2187 For any other issues, feel free to use the mailing lists. Technically
2188 interested users and people who wish to contribute to the project are also
2189 welcome on the developers list! You can find an overview of all Privoxy-related
2190 mailing lists, including list archives, at: http://sourceforge.net/mail/?
2193 -------------------------------------------------------------------------------
2195 9. Privoxy Copyright, License and History
2197 Copyright © 2001, 2002 by Privoxy Developers <developers@privoxy.org>
2199 Some source code is based on code Copyright © 1997 by Anonymous Coders and
2200 Junkbusters, Inc. and licensed under the GNU General Public License.
2202 -------------------------------------------------------------------------------
2206 Privoxy is free software; you can redistribute it and/or modify it under the
2207 terms of the GNU General Public License, version 2, as published by the Free
2208 Software Foundation.
2210 This program is distributed in the hope that it will be useful, but WITHOUT ANY
2211 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
2212 PARTICULAR PURPOSE. See the GNU General Public License for more details, which
2213 is available from the Free Software Foundation, Inc, 59 Temple Place - Suite
2214 330, Boston, MA 02111-1307, USA.
2216 You should have received a copy of the GNU General Public License along with
2217 this program; if not, write to the
2220 Foundation, Inc. 59 Temple Place - Suite 330
2221 Boston, MA 02111-1307
2224 -------------------------------------------------------------------------------
2228 In the beginning, there was the Internet Junkbuster, by Anonymous Coders and
2229 Junkbusters Corporation. It saved many users a lot of pain in the early days of
2230 web advertising and user tracking.
2232 But the web, its protocols and standards, and with it, the techniques for
2233 forcing users to consume ads, give up autonomy over their browsing, and for
2234 spying on them, kept evolving. Unfortunately, the Internet Junkbuster did not.
2235 Version 2.0.2, published in 1998, was (and is) the last official release
2236 available from Junkbusters Corporation. Fortunately, it had been released under
2237 the GNU GPL, which allowed further development by others.
2239 So Stefan Waldherr started maintaining an improved version of the software, to
2240 which eventually a number of people contributed patches. It could already
2241 replace banners with a transparent image, and had a first version of pop-up
2242 killing, but it was still very closely based on the original, with all its
2243 limitations, such as the lack of HTTP/1.1 support, flexible per-site
2244 configuration, or content modification. The last release from this effort was
2245 version 2.0.2-10, published in 2000.
2247 Then, some developers picked up the thread, and started turning the software
2248 inside out, upside down, and then reassembled it, adding many new features
2251 The result of this is Privoxy, whose first stable release, 3.0, was released
2254 -------------------------------------------------------------------------------
2258 Other references and sites of interest to Privoxy users:
2260 http://www.privoxy.org/, the Privoxy Home page.
2262 http://www.privoxy.org/faq/, the Privoxy FAQ.
2264 http://sourceforge.net/projects/ijbswa/, the Project Page for Privoxy on
2267 http://config.privoxy.org/, the web-based user interface. Privoxy must be
2268 running for this to work. Shortcut: http://p.p/
2270 http://www.privoxy.org/actions/, to submit "misses" to the developers.
2272 http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool and fun
2273 ideas from Privoxy users.
2275 http://www.junkbusters.com/ht/en/cookies.html, an explanation how cookies are
2276 used to track web users.
2278 http://www.junkbusters.com/ijb.html, the original Internet Junkbuster.
2280 http://www.waldherr.org/junkbuster/, Stefan Waldherr's version of Junkbuster,
2281 from which Privoxy was derived.
2283 http://privacy.net/analyze/, a useful site to check what information about you
2284 is leaked while you browse the web.
2286 http://www.squid-cache.org/, a very popular caching proxy, which is often used
2287 together with Privoxy.
2289 http://www.privoxy.org/developer-manual/, the Privoxy developer manual.
projects / privoxy.git / blob