1 Privoxy Developer Manual
5 $Id: developer-manual.sgml,v 1.39 2002/05/02 15:08:25 oes Exp $
7 The developer manual gives the users information on how to help the developer
8 team. It provides guidance on coding, testing, documentation and other issues.
10 You can find the latest version of the this manual at http://www.privoxy.org/
11 developer-manual/. Please see the Contact section on how to contact the
14 -------------------------------------------------------------------------------
19 3. Quickstart to Privoxy Development
23 4.2. CVS Commit Guideline
24 4.3. Discussing Changes First
26 5. Documentation Guidelines
28 5.1. Quickstart to Docbook and SGML
29 5.2. Privoxy Documentation Style
30 5.3. Privoxy Custom Entities
37 6.2.1. Comment, Comment, Comment
38 6.2.2. Use blocks for comments
39 6.2.3. Keep Comments on their own line
40 6.2.4. Comment each logical step
41 6.2.5. Comment All Functions Thoroughly
42 6.2.6. Comment at the end of braces if the content is more than one
45 6.3. Naming Conventions
49 6.3.3. Header file prototypes
50 6.3.4. Enumerations, and #defines
55 6.4.1. Put braces on a line by themselves.
56 6.4.2. ALL control statements should have a block
57 6.4.3. Do not belabor/blow-up boolean expressions
58 6.4.4. Use white space freely because it is free
59 6.4.5. Don't use white space around structure operators
60 6.4.6. Make the last brace of a function stand out
61 6.4.7. Use 3 character indentions
65 6.5.1. Initialize all variables
69 6.6.1. Name functions that return a boolean as a question.
70 6.6.2. Always specify a return type for a function.
71 6.6.3. Minimize function calls when iterating by using variables
72 6.6.4. Pass and Return by Const Reference
73 6.6.5. Pass and Return by Value
74 6.6.6. Names of include files
75 6.6.7. Provide multiple inclusion protection
76 6.6.8. Use `extern "C"` when appropriate
77 6.6.9. Where Possible, Use Forward Struct Declaration Instead of
80 6.7. General Coding Practices
82 6.7.1. Turn on warnings
83 6.7.2. Provide a default case for all switch statements
84 6.7.3. Try to avoid falling through cases in a switch statement.
85 6.7.4. Use 'long' or 'short' Instead of 'int'
86 6.7.5. Don't mix size_t and other types
87 6.7.6. Declare each variable and struct on its own line.
88 6.7.7. Use malloc/zalloc sparingly
89 6.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
91 6.7.9. Add loaders to the `file_list' structure and in order
92 6.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
94 6.8. Addendum: Template for files and function comment blocks:
98 7.1. Testplan for releases
101 8. Releasing a New Version
104 8.2. Before the Release: Freeze
105 8.3. Building and Releasing the Packages
107 8.3.1. Source Tarball
108 8.3.2. SuSE or Red Hat RPM
119 8.4. Uploading and Releasing Your Package
120 8.5. After the Release
122 9. Update the Webserver
123 10. Contacting the developers, Bug Reporting and Feature Requests
127 10.3. Request new features
128 10.4. Report ads or other filter problems
131 11. Copyright and History
138 -------------------------------------------------------------------------------
142 Privoxy, as an heir to Junkbuster, is an Open Source project and licensed under
143 the GPL. As such, Privoxy development is potentially open to anyone who has the
144 time, knowledge, and desire to contribute in any capacity. Our goals are simply
145 to continue the mission, to improve Privoxy, and to make it available to as
146 wide an audience as possible.
148 One does not have to be a programmer to contribute. Packaging, testing, and
149 porting, are all important jobs as well.
151 -------------------------------------------------------------------------------
153 3. Quickstart to Privoxy Development
155 You'll need an account on Sourceforge to support our development. Mail your ID
156 to the list and wait until a project manager has added you.
158 For the time being (read, this section is under construction), please refer to
159 the extensive comments in the source code.
161 -------------------------------------------------------------------------------
163 4. 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.
169 -------------------------------------------------------------------------------
173 The project's CVS repository is hosted on SourceForge. Please refer to the
174 chapters 6 and 7 in SF's site documentation for the technical access details
175 for your operating system. For historical reasons, the CVS server is called
176 cvs.ijbswa.sourceforge.net, the repository is called ijbswa, and the source
177 tree module is called current.
179 -------------------------------------------------------------------------------
181 4.2. CVS Commit Guideline
183 The source tree is the heart of every software project. Every effort must be
184 made to ensure that it is readable, compilable and consistent at all times. We
185 therefore ask anyone with CVS access to strictly adhere to the following
188 * Never (read: never, ever) be tempted to commit that small change without
189 testing it thoroughly first. When we're close to a public release, ask a
190 fellow developer to review your changes.
192 * Your commit message should give a concise overview of what you changed (no
193 big details) and why you changed it Just check previous messages for good
196 * Don't use the same message on multiple files, unless it equally applies to
199 * If your changes span multiple files, and the code won't recompile unless
200 all changes are commited (e.g. when changing the signature of a function),
201 then commit all files one after another, without long delays in beween. If
202 necessary, prepare the commit messages in advance.
204 * Before changing things on CVS, make sure that your changes are in line with
205 the team's general consensus on what should be done (see below).
207 -------------------------------------------------------------------------------
209 4.3. Discussing Changes First
211 We don't have a too formal policy on this, just use common sense. Hints: If it
214 1. ..a bugfix / clean-up / cosmetic thing: shoot
216 2. ..a new feature that can be turned off: shoot
218 3. ..a clear improvement w/o side effects on other parts of the code: shoot
220 4. ..a matter of taste: ask the list
222 5. ..a major redesign of some part of the code: ask the list
224 Note that near a major public release, we get a bit more cautious - if unsure,
225 it doesn't hurt to ask first. There is always the possibility to submit a patch
226 to the patches tracker instead.
228 -------------------------------------------------------------------------------
230 5. Documentation Guidelines
232 All formal documents are maintained in Docbook SGML and located in the doc/
233 source/* directory. You will need Docbook, the Docbook DTD's and the Docbook
234 modular stylesheets (or comparable alternatives), and either jade or openjade
235 (recommended) installed in order to build docs from source. Currently there is
236 user-manual, FAQ, and, of course this, the developer-manual in this format. The
237 README, AUTHORS privoxy.1 (man page) files are also now maintained as Docbook
238 SGML. The finished files are all in the top-level source directory are
239 generated files! Also, index.html, the Privoxy home page, is maintained as
240 SGML. DO NOT edit these directly. Edit the SGML source, or contact someone
241 involved in the documentation (at present Stefan and Hal).
243 Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain
244 text files in the top-level source directory. At least for the time being.
246 Packagers are encouraged to include this documentation. For those without the
247 ability to build the docs locally, text versions of each are kept in CVS. HTML
248 versions are also now being kept in CVS under doc/webserver/*.
250 Formal documents are built with the Makefile targets of make dok, or
251 alternately make redhat-dok. If you have problems, try both. The build process
252 uses the document SGML sources in doc/source/*/* to update all text files in
253 doc/text/ and to update all HTML documents in doc/webserver/.
255 Documentation writers should please make sure documents build successfully
256 before committing to CVS, if possible.
258 How do you update the webserver (i.e. the pages on privoxy.org)?
260 1. First, build the docs by running make dok (or alternately make redhat-dok).
262 2. Run make webserver which copies all files from doc/webserver to the
263 sourceforge webserver via scp.
265 Finished docs should be occasionally submitted to CVS (doc/webserver/*/*.html)
266 so that those without the ability to build them locally, have access to them if
267 needed. This is especially important just prior to a new release! Please do
268 this after the $VERSION and other release specific data in configure.in has
269 been updated (this is done just prior to a new release).
271 -------------------------------------------------------------------------------
273 5.1. Quickstart to Docbook and SGML
275 If you are not familiar with SGML, it is a markup language similar to HTML.
276 Actually, not a mark up language per se, but a language used to define markup
277 languages. In fact, HTML is an SGML application. Both will use "tags" to format
278 text and other content. SGML tags can be much more varied, and flexible, but do
279 much of the same kinds of things. The tags, or "elements", are definable in
280 SGML. There is no set "standards". Since we are using Docbook, our tags are
281 those that are defined by Docbook. Much of how the finish document is rendered
282 is determined by the "stylesheets". The stylesheets determine how each tag gets
283 translated to HTML, or other formats.
285 Tags in Docbook SGML need to be always "closed". If not, you will likely
286 generate errors. Example: <title>My Title</title>. They are also
287 case-insensitive, but we strongly suggest using all lower case. This keeps
288 compatibility with [Docbook] XML.
290 Our documents use "sections" for the most part. Sections will be processed into
291 HTML headers (e.g. h1 for sect1). The Docbook stylesheets will use these to
292 also generate the Table of Contents for each doc. Our TOC's are set to a depth
293 of three. Meaning sect1, sect2, and sect3 will have TOC entries, but sect4 will
294 not. Each section requires a <title> element, and at least one <para>. There is
295 a limit of five section levels in Docbook, but generally three should be
296 sufficient for our purposes.
298 Some common elements that you likely will use:
300 , paragraph delimiter. Most text needs to be within paragraph elements (there
301 are some exceptions).
302 , the stylesheets make this italics.
303 , files and directories.
308 , member of the above.
309 , screen output, implies .
311 , for, doh, quoting text.
313 Look at any of the existing docs for examples of all these and more.
315 You might also find "Writing Documentation Using DocBook - A Crash Course"
318 -------------------------------------------------------------------------------
320 5.2. Privoxy Documentation Style
322 It will be easier if everyone follows a similar writing style. This just makes
323 it easier to read what someone else has written if it is all done in a similar
328 * All tags should be lower case.
330 * Tags delimiting a block of text (even small blocks) should be on their own
338 Tags marking individual words, or few words, should be in-line:
340 Just to <emphasis>emphasize</emphasis>, some text goes here.
343 * Tags should be nested and step indented for block text like: (except
350 Some text goes here in our list example.
357 This makes it easier to find the text amongst the tags ;-)
359 * Use white space to separate logical divisions within a document, like
360 between sections. Running everything together consistently makes it harder
363 * Do not hesitate to make comments. Comments can either use the <comment>
364 element, or the <!-- --> style comment familiar from HTML. (Note in Docbook
365 v4.x <comment> is replaced by <remark>.)
367 * We have an international audience. Refrain from slang, or English
368 idiosyncrasies (too many to list :). Humor also does not translate well
371 * Try to keep overall line lengths in source files to 80 characters or less
372 for obvious reasons. This is not always possible, with lengthy URLs for
375 * Our documents are available in differing formats. Right now, they are just
376 plain text, and HTML, but PDF, and others is always a future possibility.
377 Be careful with URLs (<ulink>), and avoid this mistake:
379 My favorite site is <ulink url="http://example.com">here</ulink>.
381 This will render as "My favorite site is here", which is not real helpful
382 in a text doc. Better like this:
384 My favorite site is <ulink url="http://example.com">example.com</ulink>.
386 * All documents should be spell checked occasionally. aspell can check SGML
387 with the -H option. (ispell I think too.)
389 -------------------------------------------------------------------------------
391 5.3. Privoxy Custom Entities
393 Privoxy documentation is using a number of customized "entities" to facilitate
394 documentation maintenance.
396 We are using a set of "boilerplate" files with generic text, that is used by
397 multiple docs. This way we can write something once, and use it repeatedly
398 without having to re-write the same content over and over again. If editing
399 such a file, keep in mind that it should be generic. That is the purpose; so it
400 can be used in varying contexts without additional modifications.
402 We are also using what Docbook calls "internal entities". These are like
403 variables in programming. Well, sort of. For instance, we have the p-version
404 entity that contains the current Privoxy version string. You are strongly
405 encouraged to use these where possible. Some of these obviously require
406 re-setting with each release (done by the Makefile). A sampling of custom
407 entities are listed below. See any of the main docs for examples.
409 * Re- "boilerplate" text entities are defined like:
411 <!entity supported SYSTEM "supported.sgml">
413 In this example, the contents of the file, supported.sgml is available for
414 inclusion anywhere in the doc. To make this happen, just reference the now
415 defined entity: &supported; (starts with an ampersand and ends with a
416 semi-colon), and the contents will be dumped into the finished doc at that
419 * Commonly used "internal entities":
421 p-version: the Privoxy version string, e.g. "2.9.14".
422 p-status: the project status, either "alpha", "beta", or "stable".
423 p-not-stable: use to conditionally include text in "not stable" releases
425 p-stable: just the opposite.
426 p-text: this doc is only generated as text.
428 There are others in various places that are defined for a specific purpose.
431 -------------------------------------------------------------------------------
437 This set of standards is designed to make our lives easier. It is developed
438 with the simple goal of helping us keep the "new and improved Privoxy"
439 consistent and reliable. Thus making maintenance easier and increasing chances
440 of success of the project.
442 And that of course comes back to us as individuals. If we can increase our
443 development and product efficiencies then we can solve more of the request for
444 changes/improvements and in general feel good about ourselves. ;->
446 -------------------------------------------------------------------------------
450 6.2.1. Comment, Comment, Comment
454 Comment as much as possible without commenting the obvious. For example do not
455 comment "aVariable is equal to bVariable". Instead explain why aVariable should
456 be equal to the bVariable. Just because a person can read code does not mean
457 they will understand why or what is being done. A reader may spend a lot more
458 time figuring out what is going on when a simple comment or explanation would
459 have prevented the extra research. Please help your brother IJB'ers out!
461 The comments will also help justify the intent of the code. If the comment
462 describes something different than what the code is doing then maybe a
463 programming error is occurring.
467 /* if page size greater than 1k ... */
468 if ( PageLength() > 1024 )
470 ... "block" the page up ...
473 /* if page size is small, send it in blocks */
474 if ( PageLength() > 1024 )
476 ... "block" the page up ...
479 This demonstrates 2 cases of "what not to do". The first is a
480 "syntax comment". The second is a comment that does not fit what
481 is actually being done.
483 -------------------------------------------------------------------------------
485 6.2.2. Use blocks for comments
489 Comments can help or they can clutter. They help when they are differentiated
490 from the code they describe. One line comments do not offer effective
491 separation between the comment and the code. Block identifiers do, by
492 surrounding the code with a clear, definable pattern.
496 /*********************************************************************
497 * This will stand out clearly in your code!
498 *********************************************************************/
499 if ( thisVariable == thatVariable )
501 DoSomethingVeryImportant();
505 /* unfortunately, this may not */
506 if ( thisVariable == thatVariable )
508 DoSomethingVeryImportant();
512 if ( thisVariable == thatVariable ) /* this may not either */
514 DoSomethingVeryImportant();
519 If you are trying to add a small logic comment and do not wish to "disrupt" the
520 flow of the code, feel free to use a 1 line comment which is NOT on the same
523 -------------------------------------------------------------------------------
525 6.2.3. Keep Comments on their own line
529 It goes back to the question of readability. If the comment is on the same line
530 as the code it will be harder to read than the comment that is on its own line.
532 There are three exceptions to this rule, which should be violated freely and
533 often: during the definition of variables, at the end of closing braces, when
534 used to comment parameters.
538 /*********************************************************************
539 * This will stand out clearly in your code,
540 * But the second example won't.
541 *********************************************************************/
542 if ( thisVariable == thatVariable )
544 DoSomethingVeryImportant();
547 if ( thisVariable == thatVariable ) /*can you see me?*/
549 DoSomethingVeryImportant(); /*not easily*/
553 /*********************************************************************
554 * But, the encouraged exceptions:
555 *********************************************************************/
556 int urls_read = 0; /* # of urls read + rejected */
557 int urls_rejected = 0; /* # of urls rejected */
561 DoSomethingVeryImportant();
565 short DoSomethingVeryImportant(
566 short firstparam, /* represents something */
567 short nextparam /* represents something else */ )
571 } /* -END- DoSomethingVeryImportant */
573 -------------------------------------------------------------------------------
575 6.2.4. Comment each logical step
579 Logical steps should be commented to help others follow the intent of the
580 written code and comments will make the code more readable.
582 If you have 25 lines of code without a comment, you should probably go back
583 into it to see where you forgot to put one.
585 Most "for", "while", "do", etc... loops _probably_ need a comment. After all,
586 these are usually major logic containers.
588 -------------------------------------------------------------------------------
590 6.2.5. Comment All Functions Thoroughly
594 A reader of the code should be able to look at the comments just prior to the
595 beginning of a function and discern the reason for its existence and the
596 consequences of using it. The reader should not have to read through the code
597 to determine if a given function is safe for a desired use. The proper
598 information thoroughly presented at the introduction of a function not only
599 saves time for subsequent maintenance or debugging, it more importantly aids in
600 code reuse by allowing a user to determine the safety and applicability of any
601 function for the problem at hand. As a result of such benefits, all functions
602 should contain the information presented in the addendum section of this
605 -------------------------------------------------------------------------------
607 6.2.6. Comment at the end of braces if the content is more than one screen
612 Each closing brace should be followed on the same line by a comment that
613 describes the origination of the brace if the original brace is off of the
614 screen, or otherwise far away from the closing brace. This will simplify the
615 debugging, maintenance, and readability of the code.
617 As a suggestion , use the following flags to make the comment and its brace
620 use following a closing brace: } /* -END- if() or while () or etc... */
626 DoSomethingVeryImportant();
627 ...some long list of commands...
628 } /* -END- if x is 1 */
634 DoSomethingVeryImportant();
635 ...some long list of commands...
636 } /* -END- if ( 1 == X ) */
638 -------------------------------------------------------------------------------
640 6.3. Naming Conventions
642 6.3.1. Variable Names
646 Use all lowercase, and separate words via an underscore ('_'). Do not start an
647 identifier with an underscore. (ANSI C reserves these for use by the compiler
648 and system headers.) Do not use identifiers which are reserved in ANSI C++.
649 (E.g. template, class, true, false, ...). This is in case we ever decide to
654 int ms_iis5_hack = 0;
658 int msiis5hack = 0; int msIis5Hack = 0;
660 -------------------------------------------------------------------------------
662 6.3.2. Function Names
666 Use all lowercase, and separate words via an underscore ('_'). Do not start an
667 identifier with an underscore. (ANSI C reserves these for use by the compiler
668 and system headers.) Do not use identifiers which are reserved in ANSI C++.
669 (E.g. template, class, true, false, ...). This is in case we ever decide to
674 int load_some_file( struct client_state *csp )
678 int loadsomefile( struct client_state *csp )
679 int loadSomeFile( struct client_state *csp )
681 -------------------------------------------------------------------------------
683 6.3.3. Header file prototypes
687 Use a descriptive parameter name in the function prototype in header files. Use
688 the same parameter name in the header file that you use in the c file.
692 (.h) extern int load_aclfile( struct client_state *csp );
693 (.c) int load_aclfile( struct client_state *csp )
697 (.h) extern int load_aclfile( struct client_state * ); or
698 (.h) extern int load_aclfile();
699 (.c) int load_aclfile( struct client_state *csp )
701 -------------------------------------------------------------------------------
703 6.3.4. Enumerations, and #defines
707 Use all capital letters, with underscores between words. Do not start an
708 identifier with an underscore. (ANSI C reserves these for use by the compiler
713 (enumeration) : enum Boolean { FALSE, TRUE };
714 (#define) : #define DEFAULT_SIZE 100;
716 Note: We have a standard naming scheme for #defines that toggle a feature in
717 the preprocessor: FEATURE_>, where > is a short (preferably 1 or 2 word)
722 #define FEATURE_FORCE 1
725 #define FORCE_PREFIX blah
726 #endif /* def FEATURE_FORCE */
728 -------------------------------------------------------------------------------
734 Spell common words out entirely (do not remove vowels).
736 Use only widely-known domain acronyms and abbreviations. Capitalize all letters
739 Use underscore (_) to separate adjacent acronyms and abbreviations. Never
740 terminate a name with an underscore.
744 #define USE_IMAGE_LIST 1
748 #define USE_IMG_LST 1 or
749 #define _USE_IMAGE_LIST 1 or
750 #define USE_IMAGE_LIST_ 1 or
751 #define use_image_list 1 or
752 #define UseImageList 1
754 -------------------------------------------------------------------------------
758 6.4.1. Put braces on a line by themselves.
762 The brace needs to be on a line all by itself, not at the end of the statement.
763 Curly braces should line up with the construct that they're associated with.
764 This practice makes it easier to identify the opening and closing braces for a
776 if ( this == that ) { ... }
780 if ( this == that ) { ... }
782 Note: In the special case that the if-statement is inside a loop, and it is
783 trivial, i.e. it tests for a condition that is obvious from the purpose of the
784 block, one-liners as above may optically preserve the loop structure and make
787 Status: developer-discretion.
791 while ( more lines are read )
793 /* Please document what is/is not a comment line here */
794 if ( it's a comment ) continue;
796 do_something( line );
799 -------------------------------------------------------------------------------
801 6.4.2. ALL control statements should have a block
805 Using braces to make a block will make your code more readable and less prone
806 to error. All control statements should have a block defined.
818 if ( this == that ) DoSomething(); DoSomethingElse();
822 if ( this == that ) DoSomething();
824 Note: The first example in "Instead of" will execute in a manner other than
825 that which the developer desired (per indentation). Using code braces would
826 have prevented this "feature". The "explanation" and "exception" from the point
829 -------------------------------------------------------------------------------
831 6.4.3. Do not belabor/blow-up boolean expressions
835 structure->flag = ( condition );
839 if ( condition ) { structure->flag = 1; } else { structure->flag = 0; }
841 Note: The former is readable and concise. The later is wordy and inefficient.
842 Please assume that any developer new to the project has at least a "good"
843 knowledge of C/C++. (Hope I do not offend by that last comment ... 8-)
845 -------------------------------------------------------------------------------
847 6.4.4. Use white space freely because it is free
851 Make it readable. The notable exception to using white space freely is listed
852 in the next guideline.
858 int anotherValue = 0;
859 int thisVariable = 0;
861 if ( thisVariable == thatVariable )
863 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
865 -------------------------------------------------------------------------------
867 6.4.5. Don't use white space around structure operators
871 - structure pointer operator ( "->" ) - member operator ( "." ) - functions and
874 It is a general coding practice to put pointers, references, and function
875 parentheses next to names. With spaces, the connection between the object and
876 variable/function name is not as clear.
884 Instead of: aStruct -> aMember; aStruct . aMember; FunctionName ();
886 -------------------------------------------------------------------------------
888 6.4.6. Make the last brace of a function stand out
897 } /* -END- function1 */
902 } /* -END- function2 */
906 int function1( ... ) { ...code... return( retCode ); } int function2( ... ) { }
908 Note: Use 1 blank line before the closing brace and 2 lines afterward. This
909 makes the end of function standout to the most casual viewer. Although function
910 comments help separate functions, this is still a good coding practice. In
911 fact, I follow these rules when using blocks in "for", "while", "do" loops, and
912 long if {} statements too. After all whitespace is free!
914 Status: developer-discretion on the number of blank lines. Enforced is the end
915 of function comments.
917 -------------------------------------------------------------------------------
919 6.4.7. Use 3 character indentions
923 If some use 8 character TABs and some use 3 character TABs, the code can look *
924 very* ragged. So use 3 character indentions only. If you like to use TABs, pass
925 your code through a filter such as "expand -t3" before checking in your code.
929 static const char * const url_code_map[256] =
939 return( ALWAYS_TRUE );
943 return( HOW_DID_YOU_GET_HERE );
946 return( NEVER_GETS_HERE );
950 -------------------------------------------------------------------------------
954 6.5.1. Initialize all variables
958 Do not assume that the variables declared will not be used until after they
959 have been assigned a value somewhere else in the code. Remove the chance of
960 accidentally using an unassigned variable.
968 Note: It is much easier to debug a SIGSEGV if the message says you are trying
969 to access memory address 00000000 and not 129FA012; or arrayPtr[20] causes a
970 SIGSEV vs. arrayPtr[0].
972 Status: developer-discretion if and only if the variable is assigned a value
973 "shortly after" declaration.
975 -------------------------------------------------------------------------------
979 6.6.1. Name functions that return a boolean as a question.
983 Value should be phrased as a question that would logically be answered as a
984 true or false statement
992 -------------------------------------------------------------------------------
994 6.6.2. Always specify a return type for a function.
998 The default return for a function is an int. To avoid ambiguity, create a
999 return for a function when the return has a purpose, and create a void return
1000 type if the function does not need to return anything.
1002 -------------------------------------------------------------------------------
1004 6.6.3. Minimize function calls when iterating by using variables
1008 It is easy to write the following code, and a clear argument can be made that
1009 the code is easy to understand:
1013 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
1018 Note: Unfortunately, this makes a function call for each and every iteration.
1019 This increases the overhead in the program, because the compiler has to look up
1020 the function each time, call it, and return a value. Depending on what occurs
1021 in the blockListLength() call, it might even be creating and destroying
1022 structures with each iteration, even though in each case it is comparing "cnt"
1023 to the same value, over and over. Remember too - even a call to blockListLength
1024 () is a function call, with the same overhead.
1026 Instead of using a function call during the iterations, assign the value to a
1027 variable, and evaluate using the variable.
1031 size_t len = blockListLength();
1033 for ( size_t cnt = 0; cnt < len; cnt ++ )
1038 Exceptions: if the value of blockListLength() *may* change or could *
1039 potentially* change, then you must code the function call in the for/while
1042 -------------------------------------------------------------------------------
1044 6.6.4. Pass and Return by Const Reference
1048 This allows a developer to define a const pointer and call your function. If
1049 your function does not have the const keyword, we may not be able to use your
1050 function. Consider strcmp, if it were defined as: extern int strcmp( char *s1,
1053 I could then not use it to compare argv's in main: int main( int argc, const
1054 char *argv[] ) { strcmp( argv[0], "privoxy" ); }
1056 Both these pointers are *const*! If the c runtime library maintainers do it, we
1059 -------------------------------------------------------------------------------
1061 6.6.5. Pass and Return by Value
1065 Most structures cannot fit onto a normal stack entry (i.e. they are not 4 bytes
1066 or less). Aka, a function declaration like: int load_aclfile( struct
1069 would not work. So, to be consistent, we should declare all prototypes with
1070 "pass by value": int load_aclfile( struct client_state *csp )
1072 -------------------------------------------------------------------------------
1074 6.6.6. Names of include files
1078 Your include statements should contain the file name without a path. The path
1079 should be listed in the Makefile, using -I as processor directive to search the
1080 indicated paths. An exception to this would be for some proprietary software
1081 that utilizes a partial path to distinguish their header files from system or
1086 #include /* This is not a local include */
1087 #include "config.h" /* This IS a local include */
1091 /* This is not a local include, but requires a path element. */
1094 Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
1095 This duplicates the #include "file.h" behavior.
1097 -------------------------------------------------------------------------------
1099 6.6.7. Provide multiple inclusion protection
1103 Prevents compiler and linker errors resulting from redefinition of items.
1105 Wrap each header file with the following syntax to prevent multiple inclusions
1106 of the file. Of course, replace PROJECT_H with your file name, with "." Changed
1107 to "_", and make it uppercase.
1111 #ifndef PROJECT_H_INCLUDED
1112 #define PROJECT_H_INCLUDED
1114 #endif /* ndef PROJECT_H_INCLUDED */
1116 -------------------------------------------------------------------------------
1118 6.6.8. Use `extern "C"` when appropriate
1122 If our headers are included from C++, they must declare our functions as
1123 `extern "C"`. This has no cost in C, but increases the potential re-usability
1131 #endif /* def __cplusplus */
1133 ... function definitions here ...
1137 #endif /* def __cplusplus */
1139 -------------------------------------------------------------------------------
1141 6.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
1145 Useful in headers that include pointers to other struct's. Modifications to
1146 excess header files may cause needless compiles.
1150 /*********************************************************************
1151 * We're avoiding an include statement here!
1152 *********************************************************************/
1154 extern file_list *xyz;
1156 Note: If you declare "file_list xyz;" (without the pointer), then including the
1157 proper header file is necessary. If you only want to prototype a pointer,
1158 however, the header file is unnecessary.
1160 Status: Use with discretion.
1162 -------------------------------------------------------------------------------
1164 6.7. General Coding Practices
1166 6.7.1. Turn on warnings
1170 Compiler warnings are meant to help you find bugs. You should turn on as many
1171 as possible. With GCC, the switch is "-Wall". Try and fix as many warnings as
1174 -------------------------------------------------------------------------------
1176 6.7.2. Provide a default case for all switch statements
1180 What you think is guaranteed is never really guaranteed. The value that you
1181 don't think you need to check is the one that someday will be passed. So, to
1182 protect yourself from the unknown, always have a default step in a switch
1187 switch( hash_string( cmd ) )
1189 case hash_actions_file :
1199 ... anomaly code goes here ...
1200 continue; / break; / exit( 1 ); / etc ...
1202 } /* end switch( hash_string( cmd ) ) */
1204 Note: If you already have a default condition, you are obviously exempt from
1205 this point. Of note, most of the WIN32 code calls `DefWindowProc' after the
1206 switch statement. This API call *should* be included in a default statement.
1208 Another Note: This is not so much a readability issue as a robust programming
1209 issue. The "anomaly code goes here" may be no more than a print to the STDERR
1210 stream (as in load_config). Or it may really be an ABEND condition.
1212 Status: Programmer discretion is advised.
1214 -------------------------------------------------------------------------------
1216 6.7.3. Try to avoid falling through cases in a switch statement.
1220 In general, you will want to have a 'break' statement within each 'case' of a
1221 switch statement. This allows for the code to be more readable and
1222 understandable, and furthermore can prevent unwanted surprises if someone else
1223 later gets creative and moves the code around.
1225 The language allows you to plan the fall through from one case statement to
1226 another simply by omitting the break statement within the case statement. This
1227 feature does have benefits, but should only be used in rare cases. In general,
1228 use a break statement for each case statement.
1230 If you choose to allow fall through, you should comment both the fact of the
1231 fall through and reason why you felt it was necessary.
1233 -------------------------------------------------------------------------------
1235 6.7.4. Use 'long' or 'short' Instead of 'int'
1239 On 32-bit platforms, int usually has the range of long. On 16-bit platforms,
1240 int has the range of short.
1242 Status: open-to-debate. In the case of most FSF projects (including X/
1243 GNU-Emacs), there are typedefs to int4, int8, int16, (or equivalence ... I
1244 forget the exact typedefs now). Should we add these to IJB now that we have a
1247 -------------------------------------------------------------------------------
1249 6.7.5. Don't mix size_t and other types
1253 The type of size_t varies across platforms. Do not make assumptions about
1254 whether it is signed or unsigned, or about how long it is. Do not compare a
1255 size_t against another variable of a different type (or even against a
1256 constant) without casting one of the values. Try to avoid using size_t if you
1259 -------------------------------------------------------------------------------
1261 6.7.6. Declare each variable and struct on its own line.
1265 It can be tempting to declare a series of variables all on one line. Don't.
1277 Explanation: - there is more room for comments on the individual variables -
1278 easier to add new variables without messing up the original ones - when
1279 searching on a variable to find its type, there is less clutter to "visually"
1282 Exceptions: when you want to declare a bunch of loop variables or other trivial
1283 variables; feel free to declare them on 1 line. You should, although, provide a
1284 good comment on their functions.
1286 Status: developer-discretion.
1288 -------------------------------------------------------------------------------
1290 6.7.7. Use malloc/zalloc sparingly
1294 Create a local struct (on the stack) if the variable will live and die within
1295 the context of one function call.
1297 Only "malloc" a struct (on the heap) if the variable's life will extend beyond
1298 the context of one function call.
1302 If a function creates a struct and stores a pointer to it in a
1303 list, then it should definitely be allocated via `malloc'.
1305 -------------------------------------------------------------------------------
1307 6.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
1311 If you have to "malloc" an instance, you are responsible for insuring that the
1312 instance is `free'd, even if the deallocation event falls within some other
1313 programmer's code. You are also responsible for ensuring that deletion is
1314 timely (i.e. not too soon, not too late). This is known as "low-coupling" and
1315 is a "good thing (tm)". You may need to offer a free/unload/destuctor type
1316 function to accommodate this.
1320 int load_re_filterfile( struct client_state *csp ) { ... }
1321 static void unload_re_filterfile( void *f ) { ... }
1325 The developer cannot be expected to provide `free'ing functions for C run-time
1326 library functions ... such as `strdup'.
1328 Status: developer-discretion. The "main" use of this standard is for allocating
1329 and freeing data structures (complex or nested).
1331 -------------------------------------------------------------------------------
1333 6.7.9. Add loaders to the `file_list' structure and in order
1337 I have ordered all of the "blocker" file code to be in alpha order. It is
1338 easier to add/read new blockers when you expect a certain order.
1340 Note: It may appear that the alpha order is broken in places by POPUP tests
1341 coming before PCRS tests. But since POPUPs can also be referred to as
1342 KILLPOPUPs, it is clear that it should come first.
1344 -------------------------------------------------------------------------------
1346 6.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
1350 If you have enough confidence in new code or confidence in your changes, but
1351 are not *quite* sure of the repercussions, add this:
1353 /* FIXME: this code has a logic error on platform XYZ, * attempting to fix */ #
1354 ifdef PLATFORM ...changed code here... #endif
1358 /* FIXME: I think the original author really meant this... */ ...changed code
1363 /* FIXME: new code that *may* break something else... */ ...new code here...
1365 Note: If you make it clear that this may or may not be a "good thing (tm)", it
1366 will be easier to identify and include in the project (or conversely exclude
1369 -------------------------------------------------------------------------------
1371 6.8. Addendum: Template for files and function comment blocks:
1373 Example for file comments:
1375 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.39 2002/05/02 15:08:25 oes Exp $";
1376 /*********************************************************************
1380 * Purpose : (Fill me in with a good description!)
1382 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1383 * Privoxy team. http://www.privoxy.org/
1385 * Based on the Internet Junkbuster originally written
1386 * by and Copyright (C) 1997 Anonymous Coders and
1387 * Junkbusters Corporation. http://www.junkbusters.com
1389 * This program is free software; you can redistribute it
1390 * and/or modify it under the terms of the GNU General
1391 * Public License as published by the Free Software
1392 * Foundation; either version 2 of the License, or (at
1393 * your option) any later version.
1395 * This program is distributed in the hope that it will
1396 * be useful, but WITHOUT ANY WARRANTY; without even the
1397 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1398 * PARTICULAR PURPOSE. See the GNU General Public
1399 * License for more details.
1401 * The GNU General Public License should be included with
1402 * this file. If not, you can view it at
1403 * http://www.gnu.org/copyleft/gpl.html
1404 * or write to the Free Software Foundation, Inc., 59
1405 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1410 *********************************************************************/
1415 ...necessary include files for us to do our work...
1417 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1419 Note: This declares the rcs variables that should be added to the
1420 "show-proxy-args" page. If this is a brand new creation by you, you are free to
1421 change the "Copyright" section to represent the rights you wish to maintain.
1423 Note: The formfeed character that is present right after the comment flower box
1424 is handy for (X|GNU)Emacs users to skip the verbiage and get to the heart of
1425 the code (via `forward-page' and `backward-page'). Please include it if you
1428 Example for file header comments:
1432 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.39 2002/05/02 15:08:25 oes Exp $"
1433 /*********************************************************************
1437 * Purpose : (Fill me in with a good description!)
1439 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1440 * Privoxy team. http://www.privoxy.org/
1442 * Based on the Internet Junkbuster originally written
1443 * by and Copyright (C) 1997 Anonymous Coders and
1444 * Junkbusters Corporation. http://www.junkbusters.com
1446 * This program is free software; you can redistribute it
1447 * and/or modify it under the terms of the GNU General
1448 * Public License as published by the Free Software
1449 * Foundation; either version 2 of the License, or (at
1450 * your option) any later version.
1452 * This program is distributed in the hope that it will
1453 * be useful, but WITHOUT ANY WARRANTY; without even the
1454 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1455 * PARTICULAR PURPOSE. See the GNU General Public
1456 * License for more details.
1458 * The GNU General Public License should be included with
1459 * this file. If not, you can view it at
1460 * http://www.gnu.org/copyleft/gpl.html
1461 * or write to the Free Software Foundation, Inc., 59
1462 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1467 *********************************************************************/
1470 #include "project.h"
1476 ... function headers here ...
1479 /* Revision control strings from this header and associated .c file */
1480 extern const char FILENAME_rcs[];
1481 extern const char FILENAME_h_rcs[];
1488 #endif /* ndef _FILENAME_H */
1496 Example for function comments:
1498 /*********************************************************************
1500 * Function : FUNCTION_NAME
1502 * Description : (Fill me in with a good description!)
1505 * 1 : param1 = pointer to an important thing
1506 * 2 : x = pointer to something else
1508 * Returns : 0 => Ok, everything else is an error.
1510 *********************************************************************/
1511 int FUNCTION_NAME( void *param1, const char *x )
1518 Note: If we all follow this practice, we should be able to parse our code to
1519 create a "self-documenting" web page.
1521 -------------------------------------------------------------------------------
1523 7. Testing Guidelines
1527 -------------------------------------------------------------------------------
1529 7.1. Testplan for releases
1531 Explain release numbers. major, minor. developer releases. etc.
1533 1. Remove any existing rpm with rpm -e
1535 2. Remove any file that was left over. This includes (but is not limited to)
1543 + /etc/init.d/privoxy
1547 3. Install the rpm. Any error messages?
1549 4. start,stop,status Privoxy with the specific script (e.g. /etc/rc.d/init/
1550 privoxy stop). Reboot your machine. Does autostart work?
1552 5. Start browsing. Does Privoxy work? Logfile written?
1554 6. Remove the rpm. Any error messages? All files removed?
1556 -------------------------------------------------------------------------------
1560 Please submit test reports only with the test form at sourceforge. Three simple
1563 * Select category: the distribution you test on.
1565 * Select group: the version of Privoxy that we are about to release.
1567 * Fill the Summary and Detailed Description with something intelligent (keep
1568 it short and precise).
1570 Do not mail to the mailinglist (we cannot keep track on issues there).
1572 -------------------------------------------------------------------------------
1574 8. Releasing a New Version
1576 When we release versions of Privoxy, our work leaves our cozy secret lab and
1577 has to work in the cold RealWorld[tm]. Once it is released, there is no way to
1578 call it back, so it is very important that great care is taken to ensure that
1579 everything runs fine, and not to introduce problems in the very last minute.
1581 So when releasing a new version, please adhere exactly to the procedure
1582 outlined in this chapter.
1584 The following programs are required to follow this process: ncftpput (ncftp),
1585 scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs.
1587 -------------------------------------------------------------------------------
1589 8.1. Version numbers
1591 First you need to determine which version number the release will have. Privoxy
1592 version numbers consist of three numbers, separated by dots, like in X.Y.Z,
1595 * X, the version major, is rarely ever changed. It is increased by one if
1596 turning a development branch into stable substantially changes the
1597 functionality, user interface or configuration syntax. Majors 1 and 2 were
1598 Junkbuster, and 3 will be the first stable Privoxy release.
1600 * Y, the version minor, represents the branch within the major version. At
1601 any point in time, there are two branches being maintained: The stable
1602 branch, with an even minor, say, 2N, in which no functionality is being
1603 added and only bugfixes are made, and 2N+1, the development branch, in
1604 which the further development of Privoxy takes place. This enables us to
1605 turn the code upside down and inside out, while at the same time providing
1606 and maintaining a stable version. The minor is reset to zero (and one) when
1607 the major is inrcemented. When a development branch has matured to the
1608 point where it can be turned into stable, the old stable branch 2N is given
1609 up (i.e. no longer maintained), the former development branch 2N+1 becomes
1610 the new stable branch 2N+2, and a new development branch 2N+3 is opened.
1612 * Z, the point or sub version, represents a release of the software within a
1613 branch. It is therefore incremented immediately before each code freeze. In
1614 development branches, only the even point versions correspond to actual
1615 releases, while the odd ones denote the evolving state of the sources on
1616 CVS in between. It follows that Z is odd on CVS in development branches
1617 most of the time. There, it gets increased to an even number immediately
1618 before a code freeze, and is increased to an odd number again immediately
1619 thereafter. This ensures that builds from CVS snapshots are easily
1620 distinguished from released versions. The point version is reset to zero
1621 when the minor changes.
1623 -------------------------------------------------------------------------------
1625 8.2. Before the Release: Freeze
1627 The following must be done by one of the developers prior to each new release.
1629 * Make sure that everybody who has worked on the code in the last couple of
1630 days has had a chance to yell "no!" in case they have pending changes/fixes
1631 in their pipelines. Announce the freeze so that nobody will interfere with
1632 last minute changes.
1634 * Increment the version number (point from odd to even in development
1635 branches!) in configure.in.
1637 * If default.action has changed since last release (i.e. software release or
1638 standalone actions file release), bump up its version info to A.B in this
1641 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
1643 Then change the version info in doc/webserver/actions/index.php, line:
1644 '$required_actions_file_version = "A.B";'
1646 * If the HTML documentation is not in sync with the SGML sources you need to
1647 regenerate and upload it to the webserver. (If in doubt, just do it.) See
1648 the Section "Updating the webserver" in this manual for details.
1650 * Commit all files that were changed in the above steps!
1652 * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
1653 use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
1655 * If the release was in a development branch, increase the point version from
1656 even to odd (X.Y.(Z+1)) again in configure.in and commit your change.
1658 * On the webserver, copy the user manual to a new top-level directory called
1659 X.Y.Z. This ensures that help links from the CGI pages, which have the
1660 version as a prefix, will go into the right version of the manual. If this
1661 is a development branch release, also symlink X.Y.(Z-1) to X.Y.Z and X.Y.
1662 (Z+1) to . (i.e. dot).
1664 -------------------------------------------------------------------------------
1666 8.3. Building and Releasing the Packages
1668 Now the individual packages can be built and released. Note that for GPL
1669 reasons the first package to be released is always the source tarball.
1671 For all types of packages, including the source tarball, you must make sure
1672 that you build from clean sources by exporting the right version from CVS into
1673 an empty directory:.
1675 mkdir dist # delete or choose different name if it already exists
1677 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1678 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1680 Do NOT change a single bit, including, but not limited to version information
1681 after export from CVS. This is to make sure that all release packages, and with
1682 them, all future bug reports, are based on exactly the same code.
1684 Please find additional instructions for the source tarball and the individual
1685 platform dependent binary packages below.
1687 -------------------------------------------------------------------------------
1689 8.3.1. Source Tarball
1691 First, make sure that you have freshly exported the right version into an empty
1692 directory. (See "Building and releasing packages" above). Then run:
1695 autoheader && autoconf && ./configure
1701 To upload the package to Sourceforge, simply issue
1705 Go to the displayed URL and release the file publicly on Sourceforge. For the
1706 change log field, use the relevant section of the ChangeLog file.
1708 -------------------------------------------------------------------------------
1710 8.3.2. SuSE or Red Hat RPM
1712 In following text, replace dist with either "rh" for Red Hat or "suse" for
1715 First, make sure that you have freshly exported the right version into an empty
1716 directory. (See "Building and releasing packages" above).
1718 As the only exception to not changing anything after export from CVS, now
1719 examine the file privoxy-dist.spec and make sure that the version information
1720 and the RPM release number are correct. The RPM release numbers for each
1721 version start at one. Hence it must be reset to one if this is the first RPM
1722 for dist which is built from version X.Y.Z. Check the file list if unsure.
1723 Else, it must be set to the highest already available RPM release number for
1724 that version plus one.
1729 autoheader && autoconf && ./configure
1735 To upload the package to Sourceforge, simply issue
1737 make dist-upload rpm_packagerev
1739 where rpm_packagerev is the RPM release number as determined above. Go to the
1740 displayed URL and release the file publicly on Sourceforge. Use the release
1741 notes and change log from the source tarball package.
1743 -------------------------------------------------------------------------------
1747 First, make sure that you have freshly exported the right version into an empty
1748 directory. (See "Building and releasing packages" above). Then get the OS/2
1751 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
1753 You will need a mix of development tools. The main compilation takes place with
1754 IBM Visual Age C++. Some ancillary work takes place with GNU tools, available
1755 from various sources like hobbes.nmsu.edu. Specificially, you will need
1756 autoheader, autoconf and sh tools. The packaging takes place with WarpIN,
1757 available from various sources, including its home page: xworkplace.
1759 Change directory to the os2setup directory. Edit the os2build.cmd file to set
1760 the final executable filename. For example,
1762 installExeName='privoxyos2_setup_X.Y.Z.exe'
1764 Next, edit the IJB.wis file so the release number matches in the PACKAGEID
1767 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
1769 You're now ready to build. Run:
1773 You will find the WarpIN-installable executable in the ./files directory.
1774 Upload this anonymously to uploads.sourceforge.net/incoming, create a release
1775 for it, and you're done. Use the release notes and Change Log from the source
1778 -------------------------------------------------------------------------------
1782 Login to Sourceforge's compilefarm via ssh:
1784 ssh cf.sourceforge.net
1786 Choose the right operating system (not the Debian one). When logged in, make
1787 sure that you have freshly exported the right version into an empty directory.
1788 (See "Building and releasing packages" above). Then run:
1791 autoheader && autoconf && ./configure
1797 which creates a gzip'ed tar archive. Sadly, you cannot use make solaris-upload
1798 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1799 archive to Sourceforge's ftp server and release the file publicly. Use the
1800 release notes and Change Log from the source tarball package.
1802 -------------------------------------------------------------------------------
1806 You should ensure you have the latest version of Cygwin (from http://
1807 www.cygwin.com/). Run the following commands from within a Cygwin bash shell.
1809 First, make sure that you have freshly exported the right version into an empty
1810 directory. (See "Building and releasing packages" above). Then get the Windows
1813 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
1815 Then you can build the package. This is fully automated, and is controlled by
1816 winsetup/GNUmakefile. All you need to do is:
1821 Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
1822 upload it to SourceForge. When releasing the package on SourceForge, use the
1823 release notes and Change Log from the source tarball package.
1825 -------------------------------------------------------------------------------
1829 First, make sure that you have freshly exported the right version into an empty
1830 directory. (See "Building and releasing packages" above). Then, run:
1833 autoheader && autoconf && ./configure
1837 -------------------------------------------------------------------------------
1841 First, make sure that you have freshly exported the right version into an empty
1842 directory. (See "Building and releasing packages" above). Then get the Mac OSX
1845 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
1852 This will run autoheader, autoconf and configure as well as make. Finally, it
1853 will copy over the necessary files to the ./osxsetup/files directory for
1854 further processing by PackageMaker.
1856 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the
1857 package name to match the release, and hit the "Create package" button. If you
1858 specify ./Privoxy.pkg as the output package name, you can then create the
1859 distributable zip file with the command:
1861 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
1863 You can then upload privoxyosx_setup_x.y.z.zip anonymously to
1864 uploads.sourceforge.net/incoming, create a release for it, and you're done. Use
1865 the release notes and Change Log from the source tarball package.
1867 -------------------------------------------------------------------------------
1871 Login to Sourceforge's compilefarm via ssh:
1873 ssh cf.sourceforge.net
1875 Choose the right operating system. When logged in, make sure that you have
1876 freshly exported the right version into an empty directory. (See "Building and
1877 releasing packages" above). Then run:
1880 autoheader && autoconf && ./configure
1886 which creates a gzip'ed tar archive. Sadly, you cannot use make freebsd-upload
1887 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1888 archive to Sourceforge's ftp server and release the file publicly. Use the
1889 release notes and Change Log from the source tarball package.
1891 -------------------------------------------------------------------------------
1895 First, make sure that you have freshly exported the right version into an empty
1896 directory. (See "Building and releasing packages" above). Then run:
1899 autoheader && autoconf && ./configure
1903 -------------------------------------------------------------------------------
1907 First, make sure that you have freshly exported the right version into an empty
1908 directory. (See "Building and releasing packages" above). Then run:
1911 autoheader && autoconf && ./configure
1915 -------------------------------------------------------------------------------
1919 Login to Sourceforge's compilefarm via ssh:
1921 ssh cf.sourceforge.net
1923 Choose the right operating system. When logged in, make sure that you have
1924 freshly exported the right version into an empty directory. (See "Building and
1925 releasing packages" above). Then run:
1928 autoheader && autoconf && ./configure
1934 which creates a gzip'ed tar archive. Sadly, you cannot use make aix-upload on
1935 the Sourceforge machine (no ncftpput). You now have to manually upload the
1936 archive to Sourceforge's ftp server and release the file publicly. Use the
1937 release notes and Change Log from the source tarball package.
1939 -------------------------------------------------------------------------------
1941 8.4. Uploading and Releasing Your Package
1943 After the package is ready, it is time to upload it to SourceForge, and go
1944 through the release steps. The upload is done via FTP:
1946 * Upload to: ftp://upload.sourceforge.net/incoming
1950 * password: ijbswa-developers@lists.sourceforge.net
1952 Once this done go to http://sourceforge.net/project/admin/editpackages.php?
1953 group_id=11118, making sure you are logged in. Find your target platform in the
1954 second column, and click Add Release. You will then need to create a new
1955 release for your package, using the format of $VERSION ($CODE_STATUS), e.g.
1958 Now just follow the prompts. Be sure to add any appropriate Release notes. You
1959 should see your freshly uploaded packages in "Step 2. Add Files To This
1960 Release". Check the appropriate box(es). Remember at each step to hit the
1961 "Refresh/Submit" buttons! You should now see your file(s) listed in Step 3.
1962 Fill out the forms with the appropriate information for your platform, being
1963 sure to hit "Update" for each file. If anyone is monitoring your platform,
1964 check the "email" box at the very bottom to notify them of the new package.
1967 If you have made errors, or need to make changes, you can go through
1968 essentially the same steps, but select Edit Release, instead of Add Release.
1970 -------------------------------------------------------------------------------
1972 8.5. After the Release
1974 When all (or: most of the) packages have been uploaded and made available, send
1975 an email to the announce mailing list, Subject: "Version X.Y.Z available for
1976 download". Be sure to include the download location, the release notes and the
1979 -------------------------------------------------------------------------------
1981 9. Update the Webserver
1983 When updating the webserver, please follow these steps to make sure that no
1984 broken links, incosistent contents or permission problems will occur:
1986 If you have changed anything in the documentation source SGML files, do:
1988 make dok # (or make redkat-dok if make dok doesn't work for you)
1990 That will generate doc/webserver/user-manual, doc/webserver/developer-manual,
1991 doc/webserver/faq and doc/webserver/index.html automatically.
1993 If you changed the manual page source, generate doc/webserver/man-page/
1994 privoxy-man-page.html by running "make man". (This is a separate target due to
1995 dependencies on some obscure perl scripts. See comments in GNUmakefile.)
1997 If you want to add new files to the webserver, create them locally in the doc/
1998 webserver/* directory (or create new directories under doc/webserver).
2000 Next, commit any changes from the above steps to CVS. All set? Then do
2004 This will do the upload to the webserver (www.privoxy.org) and ensure all files
2005 and directories there are group writable.
2007 Please do NOT use any other means of transferring files to the webserver to
2008 avoid permission problems.
2010 -------------------------------------------------------------------------------
2012 10. Contacting the developers, Bug Reporting and Feature Requests
2014 We value your feedback. However, to provide you with the best support, please
2015 note the following sections.
2017 -------------------------------------------------------------------------------
2021 To get support, use the Sourceforge Support Forum:
2023 http://sourceforge.net/tracker/?group_id=11118&atid=211118
2025 -------------------------------------------------------------------------------
2029 To submit bugs, use the Sourceforge Bug Forum:
2031 http://sourceforge.net/tracker/?group_id=11118&atid=111118.
2033 Make sure that the bug has not already been submitted. Please try to verify
2034 that it is a Privoxy bug, and not a browser or site bug first. If you are using
2035 your own custom configuration, please try the stock configs to see if the
2036 problem is a configuration related bug. And if not using the latest development
2037 snapshot, please try the latest one. Or even better, CVS sources. Please be
2038 sure to include the Privoxy version, platform, browser, any pertinent log data,
2039 any other relevant details (please be specific) and, if possible, some way to
2042 -------------------------------------------------------------------------------
2044 10.3. Request new features
2046 To submit ideas on new features, use the Sourceforge feature request forum:
2048 http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
2050 -------------------------------------------------------------------------------
2052 10.4. Report ads or other filter problems
2054 You can also send feedback on websites that Privoxy has problems with. Please
2055 bookmark the following link: "Privoxy - Submit Filter Feedback". Once you surf
2056 to a page with problems, use the bookmark to send us feedback. We will look
2057 into the issue as soon as possible.
2059 New, improved default.action files will occasionally be made available based on
2060 your feedback. These will be announced on the ijbswa-announce list.
2062 -------------------------------------------------------------------------------
2066 For any other issues, feel free to use the mailing lists:
2068 http://sourceforge.net/mail/?group_id=11118.
2070 Anyone interested in actively participating in development and related
2071 discussions can also join the appropriate mailing list. Archives are available,
2072 too. See the page on Sourceforge.
2074 -------------------------------------------------------------------------------
2076 11. Copyright and History
2080 Privoxy is free software; you can redistribute it and/or modify it under the
2081 terms of the GNU General Public License as published by the Free Software
2082 Foundation; either version 2 of the License, or (at your option) any later
2085 This program is distributed in the hope that it will be useful, but WITHOUT ANY
2086 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
2087 PARTICULAR PURPOSE. See the GNU General Public License for more details, which
2088 is available from the Free Software Foundation, Inc, 59 Temple Place - Suite
2089 330, Boston, MA 02111-1307, USA.
2091 You should have received a copy of the GNU General Public License along with
2092 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
2093 Place, Suite 330, Boston, MA 02111-1307 USA.
2095 -------------------------------------------------------------------------------
2099 Privoxy is evolved, and derived from, the Internet Junkbuster, with many
2100 improvments and enhancements over the original.
2102 Junkbuster was originally written by Anonymous Coders and Junkbusters
2103 Corporation, and was released as free open-source software under the GNU GPL.
2104 Stefan Waldherr made many improvements, and started the SourceForge project
2105 Privoxy to rekindle development. There are now several active developers
2106 contributing. The last stable release of Junkbuster was v2.0.2, which has now
2109 -------------------------------------------------------------------------------
2113 Other references and sites of interest to Privoxy users:
2115 http://www.privoxy.org/, The Privoxy Home page.
2117 http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on
2120 http://p.p/, access Privoxy from your browser. Alternately, http://
2121 config.privoxy.org may work in some situations where the first does not.
2123 http://p.p/, and select "Privoxy - Submit Filter Feedback" to submit "misses"
2126 http://www.junkbusters.com/ht/en/cookies.html
2128 http://www.waldherr.org/junkbuster/
2130 http://privacy.net/analyze/
2132 http://www.squid-cache.org/