1 Privoxy Developer Manual
3 Copyright © 2001, 2002 by Privoxy Developers
5 $Id: developer-manual.sgml,v 1.42 2002/05/05 20:26:02 hal9 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 1.1. Quickstart to Privoxy Development
24 2.2. CVS Commit Guideline
25 2.3. Discussing Changes First
27 3. Documentation Guidelines
29 3.1. Quickstart to Docbook and SGML
30 3.2. Privoxy Documentation Style
31 3.3. Privoxy Custom Entities
38 4.2.1. Comment, Comment, Comment
39 4.2.2. Use blocks for comments
40 4.2.3. Keep Comments on their own line
41 4.2.4. Comment each logical step
42 4.2.5. Comment All Functions Thoroughly
43 4.2.6. Comment at the end of braces if the content is more than one
46 4.3. Naming Conventions
50 4.3.3. Header file prototypes
51 4.3.4. Enumerations, and #defines
56 4.4.1. Put braces on a line by themselves.
57 4.4.2. ALL control statements should have a block
58 4.4.3. Do not belabor/blow-up boolean expressions
59 4.4.4. Use white space freely because it is free
60 4.4.5. Don't use white space around structure operators
61 4.4.6. Make the last brace of a function stand out
62 4.4.7. Use 3 character indentions
66 4.5.1. Initialize all variables
70 4.6.1. Name functions that return a boolean as a question.
71 4.6.2. Always specify a return type for a function.
72 4.6.3. Minimize function calls when iterating by using variables
73 4.6.4. Pass and Return by Const Reference
74 4.6.5. Pass and Return by Value
75 4.6.6. Names of include files
76 4.6.7. Provide multiple inclusion protection
77 4.6.8. Use `extern "C"` when appropriate
78 4.6.9. Where Possible, Use Forward Struct Declaration Instead of
81 4.7. General Coding Practices
83 4.7.1. Turn on warnings
84 4.7.2. Provide a default case for all switch statements
85 4.7.3. Try to avoid falling through cases in a switch statement.
86 4.7.4. Use 'long' or 'short' Instead of 'int'
87 4.7.5. Don't mix size_t and other types
88 4.7.6. Declare each variable and struct on its own line.
89 4.7.7. Use malloc/zalloc sparingly
90 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
92 4.7.9. Add loaders to the `file_list' structure and in order
93 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
95 4.8. Addendum: Template for files and function comment blocks:
99 5.1. Testplan for releases
102 6. Releasing a New Version
105 6.2. Before the Release: Freeze
106 6.3. Building and Releasing the Packages
108 6.3.1. Source Tarball
109 6.3.2. SuSE or Red Hat RPM
120 6.4. Uploading and Releasing Your Package
121 6.5. After the Release
123 7. Update the Webserver
124 8. Contacting the developers, Bug Reporting and Feature Requests
128 8.3. Request new features
129 8.4. Report ads or other filter problems
132 9. Privoxy Copyright, License and History
141 Privoxy, as an heir to Junkbuster, is an Open Source project and licensed under
142 the GPL. As such, Privoxy development is potentially open to anyone who has the
143 time, knowledge, and desire to contribute in any capacity. Our goals are simply
144 to continue the mission, to improve Privoxy, and to make it available to as
145 wide an audience as possible.
147 One does not have to be a programmer to contribute. Packaging, testing, and
148 porting, are all important jobs as well.
150 -------------------------------------------------------------------------------
152 1.1. Quickstart to Privoxy Development
154 You'll need an account on Sourceforge to support our development. Mail your ID
155 to the list and wait until a project manager has added you.
157 For the time being (read, this section is under construction), please refer to
158 the extensive comments in the source code.
160 -------------------------------------------------------------------------------
162 2. The CVS Repository
164 If you intend to help us with programming, documentation or packaging you will
165 need write access to our holy grail, the CVS repository. Please read this
166 chapter completely before accessing via CVS.
168 -------------------------------------------------------------------------------
172 The project's CVS repository is hosted on SourceForge. Please refer to the
173 chapters 6 and 7 in SF's site documentation for the technical access details
174 for your operating system. For historical reasons, the CVS server is called
175 cvs.ijbswa.sourceforge.net, the repository is called ijbswa, and the source
176 tree module is called current.
178 -------------------------------------------------------------------------------
180 2.2. CVS Commit Guideline
182 The source tree is the heart of every software project. Every effort must be
183 made to ensure that it is readable, compilable and consistent at all times. We
184 therefore ask anyone with CVS access to strictly adhere to the following
187 * Never (read: never, ever) be tempted to commit that small change without
188 testing it thoroughly first. When we're close to a public release, ask a
189 fellow developer to review your changes.
191 * Your commit message should give a concise overview of what you changed (no
192 big details) and why you changed it Just check previous messages for good
195 * Don't use the same message on multiple files, unless it equally applies to
198 * If your changes span multiple files, and the code won't recompile unless
199 all changes are commited (e.g. when changing the signature of a function),
200 then commit all files one after another, without long delays in beween. If
201 necessary, prepare the commit messages in advance.
203 * Before changing things on CVS, make sure that your changes are in line with
204 the team's general consensus on what should be done (see below).
206 -------------------------------------------------------------------------------
208 2.3. Discussing Changes First
210 We don't have a too formal policy on this, just use common sense. Hints: If it
213 1. ..a bugfix / clean-up / cosmetic thing: shoot
215 2. ..a new feature that can be turned off: shoot
217 3. ..a clear improvement w/o side effects on other parts of the code: shoot
219 4. ..a matter of taste: ask the list
221 5. ..a major redesign of some part of the code: ask the list
223 Note that near a major public release, we get a bit more cautious - if unsure,
224 it doesn't hurt to ask first. There is always the possibility to submit a patch
225 to the patches tracker instead.
227 -------------------------------------------------------------------------------
229 3. Documentation Guidelines
231 All formal documents are maintained in Docbook SGML and located in the doc/
232 source/* directory. You will need Docbook, the Docbook DTD's and the Docbook
233 modular stylesheets (or comparable alternatives), and either jade or openjade
234 (recommended) installed in order to build docs from source. Currently there is
235 user-manual, FAQ, and, of course this, the developer-manual in this format. The
236 README, AUTHORS privoxy.1 (man page) files are also now maintained as Docbook
237 SGML. The finished files are all in the top-level source directory are
238 generated files! Also, index.html, the Privoxy home page, is maintained as
239 SGML. DO NOT edit these directly. Edit the SGML source, or contact someone
240 involved in the documentation (at present Stefan and Hal).
242 Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain
243 text files in the top-level source directory. At least for the time being.
245 Packagers are encouraged to include this documentation. For those without the
246 ability to build the docs locally, text versions of each are kept in CVS. HTML
247 versions are also now being kept in CVS under doc/webserver/*.
249 Formal documents are built with the Makefile targets of make dok, or
250 alternately make redhat-dok. If you have problems, try both. The build process
251 uses the document SGML sources in doc/source/*/* to update all text files in
252 doc/text/ and to update all HTML documents in doc/webserver/.
254 Documentation writers should please make sure documents build successfully
255 before committing to CVS, if possible.
257 How do you update the webserver (i.e. the pages on privoxy.org)?
259 1. First, build the docs by running make dok (or alternately make redhat-dok).
261 2. Run make webserver which copies all files from doc/webserver to the
262 sourceforge webserver via scp.
264 Finished docs should be occasionally submitted to CVS (doc/webserver/*/*.html)
265 so that those without the ability to build them locally, have access to them if
266 needed. This is especially important just prior to a new release! Please do
267 this after the $VERSION and other release specific data in configure.in has
268 been updated (this is done just prior to a new release).
270 -------------------------------------------------------------------------------
272 3.1. Quickstart to Docbook and SGML
274 If you are not familiar with SGML, it is a markup language similar to HTML.
275 Actually, not a mark up language per se, but a language used to define markup
276 languages. In fact, HTML is an SGML application. Both will use "tags" to format
277 text and other content. SGML tags can be much more varied, and flexible, but do
278 much of the same kinds of things. The tags, or "elements", are definable in
279 SGML. There is no set "standards". Since we are using Docbook, our tags are
280 those that are defined by Docbook. Much of how the finish document is rendered
281 is determined by the "stylesheets". The stylesheets determine how each tag gets
282 translated to HTML, or other formats.
284 Tags in Docbook SGML need to be always "closed". If not, you will likely
285 generate errors. Example: <title>My Title</title>. They are also
286 case-insensitive, but we strongly suggest using all lower case. This keeps
287 compatibility with [Docbook] XML.
289 Our documents use "sections" for the most part. Sections will be processed into
290 HTML headers (e.g. h1 for sect1). The Docbook stylesheets will use these to
291 also generate the Table of Contents for each doc. Our TOC's are set to a depth
292 of three. Meaning sect1, sect2, and sect3 will have TOC entries, but sect4 will
293 not. Each section requires a <title> element, and at least one <para>. There is
294 a limit of five section levels in Docbook, but generally three should be
295 sufficient for our purposes.
297 Some common elements that you likely will use:
299 <para></para>, paragraph delimiter. Most text needs to be within paragraph
300 elements (there are some exceptions).
301 <emphasis></emphasis>, the stylesheets make this italics.
302 <filename></filename>, files and directories.
303 <command></command>, command examples.
304 <literallayout></literallayout>, like <pre>, more or less.
305 <itemizedlist></itemizedlist>, list with bullets.
306 <listitem></listitem>, member of the above.
307 <screen></screen>, screen output, implies <literallayout>.
308 <ulink url="example.com"></ulink>, like HTML <a> tag.
309 <quote></quote>, for, doh, quoting text.
311 Look at any of the existing docs for examples of all these and more.
313 You might also find "Writing Documentation Using DocBook - A Crash Course"
316 -------------------------------------------------------------------------------
318 3.2. Privoxy Documentation Style
320 It will be easier if everyone follows a similar writing style. This just makes
321 it easier to read what someone else has written if it is all done in a similar
326 * All tags should be lower case.
328 * Tags delimiting a block of text (even small blocks) should be on their own
336 Tags marking individual words, or few words, should be in-line:
338 Just to <emphasis>emphasize</emphasis>, some text goes here.
341 * Tags should be nested and step indented for block text like: (except
348 Some text goes here in our list example.
355 This makes it easier to find the text amongst the tags ;-)
357 * Use white space to separate logical divisions within a document, like
358 between sections. Running everything together consistently makes it harder
361 * Do not hesitate to make comments. Comments can either use the <comment>
362 element, or the <!-- --> style comment familiar from HTML. (Note in Docbook
363 v4.x <comment> is replaced by <remark>.)
365 * We have an international audience. Refrain from slang, or English
366 idiosyncrasies (too many to list :). Humor also does not translate well
369 * Try to keep overall line lengths in source files to 80 characters or less
370 for obvious reasons. This is not always possible, with lengthy URLs for
373 * Our documents are available in differing formats. Right now, they are just
374 plain text, and HTML, but PDF, and others is always a future possibility.
375 Be careful with URLs (<ulink>), and avoid this mistake:
377 My favorite site is <ulink url="http://example.com">here</ulink>.
379 This will render as "My favorite site is here", which is not real helpful
380 in a text doc. Better like this:
382 My favorite site is <ulink url="http://example.com">example.com</ulink>.
384 * All documents should be spell checked occasionally. aspell can check SGML
385 with the -H option. (ispell I think too.)
387 -------------------------------------------------------------------------------
389 3.3. Privoxy Custom Entities
391 Privoxy documentation is using a number of customized "entities" to facilitate
392 documentation maintenance.
394 We are using a set of "boilerplate" files with generic text, that is used by
395 multiple docs. This way we can write something once, and use it repeatedly
396 without having to re-write the same content over and over again. If editing
397 such a file, keep in mind that it should be generic. That is the purpose; so it
398 can be used in varying contexts without additional modifications.
400 We are also using what Docbook calls "internal entities". These are like
401 variables in programming. Well, sort of. For instance, we have the p-version
402 entity that contains the current Privoxy version string. You are strongly
403 encouraged to use these where possible. Some of these obviously require
404 re-setting with each release (done by the Makefile). A sampling of custom
405 entities are listed below. See any of the main docs for examples.
407 * Re- "boilerplate" text entities are defined like:
409 <!entity supported SYSTEM "supported.sgml">
411 In this example, the contents of the file, supported.sgml is available for
412 inclusion anywhere in the doc. To make this happen, just reference the now
413 defined entity: &supported; (starts with an ampersand and ends with a
414 semi-colon), and the contents will be dumped into the finished doc at that
417 * Commonly used "internal entities":
419 p-version: the Privoxy version string, e.g. "2.9.15".
420 p-status: the project status, either "alpha", "beta", or "stable".
421 p-not-stable: use to conditionally include text in "not stable" releases
423 p-stable: just the opposite.
424 p-text: this doc is only generated as text.
426 There are others in various places that are defined for a specific purpose.
429 -------------------------------------------------------------------------------
435 This set of standards is designed to make our lives easier. It is developed
436 with the simple goal of helping us keep the "new and improved Privoxy"
437 consistent and reliable. Thus making maintenance easier and increasing chances
438 of success of the project.
440 And that of course comes back to us as individuals. If we can increase our
441 development and product efficiencies then we can solve more of the request for
442 changes/improvements and in general feel good about ourselves. ;->
444 -------------------------------------------------------------------------------
448 4.2.1. Comment, Comment, Comment
452 Comment as much as possible without commenting the obvious. For example do not
453 comment "aVariable is equal to bVariable". Instead explain why aVariable should
454 be equal to the bVariable. Just because a person can read code does not mean
455 they will understand why or what is being done. A reader may spend a lot more
456 time figuring out what is going on when a simple comment or explanation would
457 have prevented the extra research. Please help your brother IJB'ers out!
459 The comments will also help justify the intent of the code. If the comment
460 describes something different than what the code is doing then maybe a
461 programming error is occurring.
465 /* if page size greater than 1k ... */
466 if ( PageLength() > 1024 )
468 ... "block" the page up ...
471 /* if page size is small, send it in blocks */
472 if ( PageLength() > 1024 )
474 ... "block" the page up ...
477 This demonstrates 2 cases of "what not to do". The first is a
478 "syntax comment". The second is a comment that does not fit what
479 is actually being done.
481 -------------------------------------------------------------------------------
483 4.2.2. Use blocks for comments
487 Comments can help or they can clutter. They help when they are differentiated
488 from the code they describe. One line comments do not offer effective
489 separation between the comment and the code. Block identifiers do, by
490 surrounding the code with a clear, definable pattern.
494 /*********************************************************************
495 * This will stand out clearly in your code!
496 *********************************************************************/
497 if ( thisVariable == thatVariable )
499 DoSomethingVeryImportant();
503 /* unfortunately, this may not */
504 if ( thisVariable == thatVariable )
506 DoSomethingVeryImportant();
510 if ( thisVariable == thatVariable ) /* this may not either */
512 DoSomethingVeryImportant();
517 If you are trying to add a small logic comment and do not wish to "disrupt" the
518 flow of the code, feel free to use a 1 line comment which is NOT on the same
521 -------------------------------------------------------------------------------
523 4.2.3. Keep Comments on their own line
527 It goes back to the question of readability. If the comment is on the same line
528 as the code it will be harder to read than the comment that is on its own line.
530 There are three exceptions to this rule, which should be violated freely and
531 often: during the definition of variables, at the end of closing braces, when
532 used to comment parameters.
536 /*********************************************************************
537 * This will stand out clearly in your code,
538 * But the second example won't.
539 *********************************************************************/
540 if ( thisVariable == thatVariable )
542 DoSomethingVeryImportant();
545 if ( thisVariable == thatVariable ) /*can you see me?*/
547 DoSomethingVeryImportant(); /*not easily*/
551 /*********************************************************************
552 * But, the encouraged exceptions:
553 *********************************************************************/
554 int urls_read = 0; /* # of urls read + rejected */
555 int urls_rejected = 0; /* # of urls rejected */
559 DoSomethingVeryImportant();
563 short DoSomethingVeryImportant(
564 short firstparam, /* represents something */
565 short nextparam /* represents something else */ )
569 } /* -END- DoSomethingVeryImportant */
571 -------------------------------------------------------------------------------
573 4.2.4. Comment each logical step
577 Logical steps should be commented to help others follow the intent of the
578 written code and comments will make the code more readable.
580 If you have 25 lines of code without a comment, you should probably go back
581 into it to see where you forgot to put one.
583 Most "for", "while", "do", etc... loops _probably_ need a comment. After all,
584 these are usually major logic containers.
586 -------------------------------------------------------------------------------
588 4.2.5. Comment All Functions Thoroughly
592 A reader of the code should be able to look at the comments just prior to the
593 beginning of a function and discern the reason for its existence and the
594 consequences of using it. The reader should not have to read through the code
595 to determine if a given function is safe for a desired use. The proper
596 information thoroughly presented at the introduction of a function not only
597 saves time for subsequent maintenance or debugging, it more importantly aids in
598 code reuse by allowing a user to determine the safety and applicability of any
599 function for the problem at hand. As a result of such benefits, all functions
600 should contain the information presented in the addendum section of this
603 -------------------------------------------------------------------------------
605 4.2.6. Comment at the end of braces if the content is more than one screen
610 Each closing brace should be followed on the same line by a comment that
611 describes the origination of the brace if the original brace is off of the
612 screen, or otherwise far away from the closing brace. This will simplify the
613 debugging, maintenance, and readability of the code.
615 As a suggestion , use the following flags to make the comment and its brace
618 use following a closing brace: } /* -END- if() or while () or etc... */
624 DoSomethingVeryImportant();
625 ...some long list of commands...
626 } /* -END- if x is 1 */
632 DoSomethingVeryImportant();
633 ...some long list of commands...
634 } /* -END- if ( 1 == X ) */
636 -------------------------------------------------------------------------------
638 4.3. Naming Conventions
640 4.3.1. Variable Names
644 Use all lowercase, and separate words via an underscore ('_'). Do not start an
645 identifier with an underscore. (ANSI C reserves these for use by the compiler
646 and system headers.) Do not use identifiers which are reserved in ANSI C++.
647 (E.g. template, class, true, false, ...). This is in case we ever decide to
652 int ms_iis5_hack = 0;
656 int msiis5hack = 0; int msIis5Hack = 0;
658 -------------------------------------------------------------------------------
660 4.3.2. Function Names
664 Use all lowercase, and separate words via an underscore ('_'). Do not start an
665 identifier with an underscore. (ANSI C reserves these for use by the compiler
666 and system headers.) Do not use identifiers which are reserved in ANSI C++.
667 (E.g. template, class, true, false, ...). This is in case we ever decide to
672 int load_some_file( struct client_state *csp )
676 int loadsomefile( struct client_state *csp )
677 int loadSomeFile( struct client_state *csp )
679 -------------------------------------------------------------------------------
681 4.3.3. Header file prototypes
685 Use a descriptive parameter name in the function prototype in header files. Use
686 the same parameter name in the header file that you use in the c file.
690 (.h) extern int load_aclfile( struct client_state *csp );
691 (.c) int load_aclfile( struct client_state *csp )
695 (.h) extern int load_aclfile( struct client_state * ); or
696 (.h) extern int load_aclfile();
697 (.c) int load_aclfile( struct client_state *csp )
699 -------------------------------------------------------------------------------
701 4.3.4. Enumerations, and #defines
705 Use all capital letters, with underscores between words. Do not start an
706 identifier with an underscore. (ANSI C reserves these for use by the compiler
711 (enumeration) : enum Boolean { FALSE, TRUE };
712 (#define) : #define DEFAULT_SIZE 100;
714 Note: We have a standard naming scheme for #defines that toggle a feature in
715 the preprocessor: FEATURE_>, where > is a short (preferably 1 or 2 word)
720 #define FEATURE_FORCE 1
723 #define FORCE_PREFIX blah
724 #endif /* def FEATURE_FORCE */
726 -------------------------------------------------------------------------------
732 Spell common words out entirely (do not remove vowels).
734 Use only widely-known domain acronyms and abbreviations. Capitalize all letters
737 Use underscore (_) to separate adjacent acronyms and abbreviations. Never
738 terminate a name with an underscore.
742 #define USE_IMAGE_LIST 1
746 #define USE_IMG_LST 1 or
747 #define _USE_IMAGE_LIST 1 or
748 #define USE_IMAGE_LIST_ 1 or
749 #define use_image_list 1 or
750 #define UseImageList 1
752 -------------------------------------------------------------------------------
756 4.4.1. Put braces on a line by themselves.
760 The brace needs to be on a line all by itself, not at the end of the statement.
761 Curly braces should line up with the construct that they're associated with.
762 This practice makes it easier to identify the opening and closing braces for a
774 if ( this == that ) { ... }
778 if ( this == that ) { ... }
780 Note: In the special case that the if-statement is inside a loop, and it is
781 trivial, i.e. it tests for a condition that is obvious from the purpose of the
782 block, one-liners as above may optically preserve the loop structure and make
785 Status: developer-discretion.
789 while ( more lines are read )
791 /* Please document what is/is not a comment line here */
792 if ( it's a comment ) continue;
794 do_something( line );
797 -------------------------------------------------------------------------------
799 4.4.2. ALL control statements should have a block
803 Using braces to make a block will make your code more readable and less prone
804 to error. All control statements should have a block defined.
816 if ( this == that ) DoSomething(); DoSomethingElse();
820 if ( this == that ) DoSomething();
822 Note: The first example in "Instead of" will execute in a manner other than
823 that which the developer desired (per indentation). Using code braces would
824 have prevented this "feature". The "explanation" and "exception" from the point
827 -------------------------------------------------------------------------------
829 4.4.3. Do not belabor/blow-up boolean expressions
833 structure->flag = ( condition );
837 if ( condition ) { structure->flag = 1; } else { structure->flag = 0; }
839 Note: The former is readable and concise. The later is wordy and inefficient.
840 Please assume that any developer new to the project has at least a "good"
841 knowledge of C/C++. (Hope I do not offend by that last comment ... 8-)
843 -------------------------------------------------------------------------------
845 4.4.4. Use white space freely because it is free
849 Make it readable. The notable exception to using white space freely is listed
850 in the next guideline.
856 int anotherValue = 0;
857 int thisVariable = 0;
859 if ( thisVariable == thatVariable )
861 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
863 -------------------------------------------------------------------------------
865 4.4.5. Don't use white space around structure operators
869 - structure pointer operator ( "->" ) - member operator ( "." ) - functions and
872 It is a general coding practice to put pointers, references, and function
873 parentheses next to names. With spaces, the connection between the object and
874 variable/function name is not as clear.
882 Instead of: aStruct -> aMember; aStruct . aMember; FunctionName ();
884 -------------------------------------------------------------------------------
886 4.4.6. Make the last brace of a function stand out
895 } /* -END- function1 */
900 } /* -END- function2 */
904 int function1( ... ) { ...code... return( retCode ); } int function2( ... ) { }
906 Note: Use 1 blank line before the closing brace and 2 lines afterward. This
907 makes the end of function standout to the most casual viewer. Although function
908 comments help separate functions, this is still a good coding practice. In
909 fact, I follow these rules when using blocks in "for", "while", "do" loops, and
910 long if {} statements too. After all whitespace is free!
912 Status: developer-discretion on the number of blank lines. Enforced is the end
913 of function comments.
915 -------------------------------------------------------------------------------
917 4.4.7. Use 3 character indentions
921 If some use 8 character TABs and some use 3 character TABs, the code can look *
922 very* ragged. So use 3 character indentions only. If you like to use TABs, pass
923 your code through a filter such as "expand -t3" before checking in your code.
927 static const char * const url_code_map[256] =
937 return( ALWAYS_TRUE );
941 return( HOW_DID_YOU_GET_HERE );
944 return( NEVER_GETS_HERE );
948 -------------------------------------------------------------------------------
952 4.5.1. Initialize all variables
956 Do not assume that the variables declared will not be used until after they
957 have been assigned a value somewhere else in the code. Remove the chance of
958 accidentally using an unassigned variable.
966 Note: It is much easier to debug a SIGSEGV if the message says you are trying
967 to access memory address 00000000 and not 129FA012; or arrayPtr[20] causes a
968 SIGSEV vs. arrayPtr[0].
970 Status: developer-discretion if and only if the variable is assigned a value
971 "shortly after" declaration.
973 -------------------------------------------------------------------------------
977 4.6.1. Name functions that return a boolean as a question.
981 Value should be phrased as a question that would logically be answered as a
982 true or false statement
990 -------------------------------------------------------------------------------
992 4.6.2. Always specify a return type for a function.
996 The default return for a function is an int. To avoid ambiguity, create a
997 return for a function when the return has a purpose, and create a void return
998 type if the function does not need to return anything.
1000 -------------------------------------------------------------------------------
1002 4.6.3. Minimize function calls when iterating by using variables
1006 It is easy to write the following code, and a clear argument can be made that
1007 the code is easy to understand:
1011 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
1016 Note: Unfortunately, this makes a function call for each and every iteration.
1017 This increases the overhead in the program, because the compiler has to look up
1018 the function each time, call it, and return a value. Depending on what occurs
1019 in the blockListLength() call, it might even be creating and destroying
1020 structures with each iteration, even though in each case it is comparing "cnt"
1021 to the same value, over and over. Remember too - even a call to blockListLength
1022 () is a function call, with the same overhead.
1024 Instead of using a function call during the iterations, assign the value to a
1025 variable, and evaluate using the variable.
1029 size_t len = blockListLength();
1031 for ( size_t cnt = 0; cnt < len; cnt ++ )
1036 Exceptions: if the value of blockListLength() *may* change or could *
1037 potentially* change, then you must code the function call in the for/while
1040 -------------------------------------------------------------------------------
1042 4.6.4. Pass and Return by Const Reference
1046 This allows a developer to define a const pointer and call your function. If
1047 your function does not have the const keyword, we may not be able to use your
1048 function. Consider strcmp, if it were defined as: extern int strcmp( char *s1,
1051 I could then not use it to compare argv's in main: int main( int argc, const
1052 char *argv[] ) { strcmp( argv[0], "privoxy" ); }
1054 Both these pointers are *const*! If the c runtime library maintainers do it, we
1057 -------------------------------------------------------------------------------
1059 4.6.5. Pass and Return by Value
1063 Most structures cannot fit onto a normal stack entry (i.e. they are not 4 bytes
1064 or less). Aka, a function declaration like: int load_aclfile( struct
1067 would not work. So, to be consistent, we should declare all prototypes with
1068 "pass by value": int load_aclfile( struct client_state *csp )
1070 -------------------------------------------------------------------------------
1072 4.6.6. Names of include files
1076 Your include statements should contain the file name without a path. The path
1077 should be listed in the Makefile, using -I as processor directive to search the
1078 indicated paths. An exception to this would be for some proprietary software
1079 that utilizes a partial path to distinguish their header files from system or
1084 #include <iostream.h> /* This is not a local include */
1085 #include "config.h" /* This IS a local include */
1089 /* This is not a local include, but requires a path element. */
1090 #include <sys/fileName.h>
1092 Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
1093 This duplicates the #include "file.h" behavior.
1095 -------------------------------------------------------------------------------
1097 4.6.7. Provide multiple inclusion protection
1101 Prevents compiler and linker errors resulting from redefinition of items.
1103 Wrap each header file with the following syntax to prevent multiple inclusions
1104 of the file. Of course, replace PROJECT_H with your file name, with "." Changed
1105 to "_", and make it uppercase.
1109 #ifndef PROJECT_H_INCLUDED
1110 #define PROJECT_H_INCLUDED
1112 #endif /* ndef PROJECT_H_INCLUDED */
1114 -------------------------------------------------------------------------------
1116 4.6.8. Use `extern "C"` when appropriate
1120 If our headers are included from C++, they must declare our functions as
1121 `extern "C"`. This has no cost in C, but increases the potential re-usability
1129 #endif /* def __cplusplus */
1131 ... function definitions here ...
1135 #endif /* def __cplusplus */
1137 -------------------------------------------------------------------------------
1139 4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
1143 Useful in headers that include pointers to other struct's. Modifications to
1144 excess header files may cause needless compiles.
1148 /*********************************************************************
1149 * We're avoiding an include statement here!
1150 *********************************************************************/
1152 extern file_list *xyz;
1154 Note: If you declare "file_list xyz;" (without the pointer), then including the
1155 proper header file is necessary. If you only want to prototype a pointer,
1156 however, the header file is unnecessary.
1158 Status: Use with discretion.
1160 -------------------------------------------------------------------------------
1162 4.7. General Coding Practices
1164 4.7.1. Turn on warnings
1168 Compiler warnings are meant to help you find bugs. You should turn on as many
1169 as possible. With GCC, the switch is "-Wall". Try and fix as many warnings as
1172 -------------------------------------------------------------------------------
1174 4.7.2. Provide a default case for all switch statements
1178 What you think is guaranteed is never really guaranteed. The value that you
1179 don't think you need to check is the one that someday will be passed. So, to
1180 protect yourself from the unknown, always have a default step in a switch
1185 switch( hash_string( cmd ) )
1187 case hash_actions_file :
1197 ... anomaly code goes here ...
1198 continue; / break; / exit( 1 ); / etc ...
1200 } /* end switch( hash_string( cmd ) ) */
1202 Note: If you already have a default condition, you are obviously exempt from
1203 this point. Of note, most of the WIN32 code calls `DefWindowProc' after the
1204 switch statement. This API call *should* be included in a default statement.
1206 Another Note: This is not so much a readability issue as a robust programming
1207 issue. The "anomaly code goes here" may be no more than a print to the STDERR
1208 stream (as in load_config). Or it may really be an ABEND condition.
1210 Status: Programmer discretion is advised.
1212 -------------------------------------------------------------------------------
1214 4.7.3. Try to avoid falling through cases in a switch statement.
1218 In general, you will want to have a 'break' statement within each 'case' of a
1219 switch statement. This allows for the code to be more readable and
1220 understandable, and furthermore can prevent unwanted surprises if someone else
1221 later gets creative and moves the code around.
1223 The language allows you to plan the fall through from one case statement to
1224 another simply by omitting the break statement within the case statement. This
1225 feature does have benefits, but should only be used in rare cases. In general,
1226 use a break statement for each case statement.
1228 If you choose to allow fall through, you should comment both the fact of the
1229 fall through and reason why you felt it was necessary.
1231 -------------------------------------------------------------------------------
1233 4.7.4. Use 'long' or 'short' Instead of 'int'
1237 On 32-bit platforms, int usually has the range of long. On 16-bit platforms,
1238 int has the range of short.
1240 Status: open-to-debate. In the case of most FSF projects (including X/
1241 GNU-Emacs), there are typedefs to int4, int8, int16, (or equivalence ... I
1242 forget the exact typedefs now). Should we add these to IJB now that we have a
1245 -------------------------------------------------------------------------------
1247 4.7.5. Don't mix size_t and other types
1251 The type of size_t varies across platforms. Do not make assumptions about
1252 whether it is signed or unsigned, or about how long it is. Do not compare a
1253 size_t against another variable of a different type (or even against a
1254 constant) without casting one of the values. Try to avoid using size_t if you
1257 -------------------------------------------------------------------------------
1259 4.7.6. Declare each variable and struct on its own line.
1263 It can be tempting to declare a series of variables all on one line. Don't.
1275 Explanation: - there is more room for comments on the individual variables -
1276 easier to add new variables without messing up the original ones - when
1277 searching on a variable to find its type, there is less clutter to "visually"
1280 Exceptions: when you want to declare a bunch of loop variables or other trivial
1281 variables; feel free to declare them on 1 line. You should, although, provide a
1282 good comment on their functions.
1284 Status: developer-discretion.
1286 -------------------------------------------------------------------------------
1288 4.7.7. Use malloc/zalloc sparingly
1292 Create a local struct (on the stack) if the variable will live and die within
1293 the context of one function call.
1295 Only "malloc" a struct (on the heap) if the variable's life will extend beyond
1296 the context of one function call.
1300 If a function creates a struct and stores a pointer to it in a
1301 list, then it should definitely be allocated via `malloc'.
1303 -------------------------------------------------------------------------------
1305 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
1309 If you have to "malloc" an instance, you are responsible for insuring that the
1310 instance is `free'd, even if the deallocation event falls within some other
1311 programmer's code. You are also responsible for ensuring that deletion is
1312 timely (i.e. not too soon, not too late). This is known as "low-coupling" and
1313 is a "good thing (tm)". You may need to offer a free/unload/destuctor type
1314 function to accommodate this.
1318 int load_re_filterfile( struct client_state *csp ) { ... }
1319 static void unload_re_filterfile( void *f ) { ... }
1323 The developer cannot be expected to provide `free'ing functions for C run-time
1324 library functions ... such as `strdup'.
1326 Status: developer-discretion. The "main" use of this standard is for allocating
1327 and freeing data structures (complex or nested).
1329 -------------------------------------------------------------------------------
1331 4.7.9. Add loaders to the `file_list' structure and in order
1335 I have ordered all of the "blocker" file code to be in alpha order. It is
1336 easier to add/read new blockers when you expect a certain order.
1338 Note: It may appear that the alpha order is broken in places by POPUP tests
1339 coming before PCRS tests. But since POPUPs can also be referred to as
1340 KILLPOPUPs, it is clear that it should come first.
1342 -------------------------------------------------------------------------------
1344 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
1348 If you have enough confidence in new code or confidence in your changes, but
1349 are not *quite* sure of the repercussions, add this:
1351 /* FIXME: this code has a logic error on platform XYZ, * attempting to fix */ #
1352 ifdef PLATFORM ...changed code here... #endif
1356 /* FIXME: I think the original author really meant this... */ ...changed code
1361 /* FIXME: new code that *may* break something else... */ ...new code here...
1363 Note: If you make it clear that this may or may not be a "good thing (tm)", it
1364 will be easier to identify and include in the project (or conversely exclude
1367 -------------------------------------------------------------------------------
1369 4.8. Addendum: Template for files and function comment blocks:
1371 Example for file comments:
1373 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.42 2002/05/05 20:26:02 hal9 Exp $";
1374 /*********************************************************************
1378 * Purpose : (Fill me in with a good description!)
1380 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1381 * Privoxy team. http://www.privoxy.org/
1383 * Based on the Internet Junkbuster originally written
1384 * by and Copyright (C) 1997 Anonymous Coders and
1385 * Junkbusters Corporation. http://www.junkbusters.com
1387 * This program is free software; you can redistribute it
1388 * and/or modify it under the terms of the GNU General
1389 * Public License as published by the Free Software
1390 * Foundation; either version 2 of the License, or (at
1391 * your option) any later version.
1393 * This program is distributed in the hope that it will
1394 * be useful, but WITHOUT ANY WARRANTY; without even the
1395 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1396 * PARTICULAR PURPOSE. See the GNU General Public
1397 * License for more details.
1399 * The GNU General Public License should be included with
1400 * this file. If not, you can view it at
1401 * http://www.gnu.org/copyleft/gpl.html
1402 * or write to the Free Software Foundation, Inc., 59
1403 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1408 *********************************************************************/
1413 ...necessary include files for us to do our work...
1415 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1417 Note: This declares the rcs variables that should be added to the
1418 "show-proxy-args" page. If this is a brand new creation by you, you are free to
1419 change the "Copyright" section to represent the rights you wish to maintain.
1421 Note: The formfeed character that is present right after the comment flower box
1422 is handy for (X|GNU)Emacs users to skip the verbiage and get to the heart of
1423 the code (via `forward-page' and `backward-page'). Please include it if you
1426 Example for file header comments:
1430 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.42 2002/05/05 20:26:02 hal9 Exp $"
1431 /*********************************************************************
1435 * Purpose : (Fill me in with a good description!)
1437 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1438 * Privoxy team. http://www.privoxy.org/
1440 * Based on the Internet Junkbuster originally written
1441 * by and Copyright (C) 1997 Anonymous Coders and
1442 * Junkbusters Corporation. http://www.junkbusters.com
1444 * This program is free software; you can redistribute it
1445 * and/or modify it under the terms of the GNU General
1446 * Public License as published by the Free Software
1447 * Foundation; either version 2 of the License, or (at
1448 * your option) any later version.
1450 * This program is distributed in the hope that it will
1451 * be useful, but WITHOUT ANY WARRANTY; without even the
1452 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1453 * PARTICULAR PURPOSE. See the GNU General Public
1454 * License for more details.
1456 * The GNU General Public License should be included with
1457 * this file. If not, you can view it at
1458 * http://www.gnu.org/copyleft/gpl.html
1459 * or write to the Free Software Foundation, Inc., 59
1460 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1465 *********************************************************************/
1468 #include "project.h"
1474 ... function headers here ...
1477 /* Revision control strings from this header and associated .c file */
1478 extern const char FILENAME_rcs[];
1479 extern const char FILENAME_h_rcs[];
1486 #endif /* ndef _FILENAME_H */
1494 Example for function comments:
1496 /*********************************************************************
1498 * Function : FUNCTION_NAME
1500 * Description : (Fill me in with a good description!)
1503 * 1 : param1 = pointer to an important thing
1504 * 2 : x = pointer to something else
1506 * Returns : 0 => Ok, everything else is an error.
1508 *********************************************************************/
1509 int FUNCTION_NAME( void *param1, const char *x )
1516 Note: If we all follow this practice, we should be able to parse our code to
1517 create a "self-documenting" web page.
1519 -------------------------------------------------------------------------------
1521 5. Testing Guidelines
1525 -------------------------------------------------------------------------------
1527 5.1. Testplan for releases
1529 Explain release numbers. major, minor. developer releases. etc.
1531 1. Remove any existing rpm with rpm -e
1533 2. Remove any file that was left over. This includes (but is not limited to)
1541 + /etc/init.d/privoxy
1545 3. Install the rpm. Any error messages?
1547 4. start,stop,status Privoxy with the specific script (e.g. /etc/rc.d/init/
1548 privoxy stop). Reboot your machine. Does autostart work?
1550 5. Start browsing. Does Privoxy work? Logfile written?
1552 6. Remove the rpm. Any error messages? All files removed?
1554 -------------------------------------------------------------------------------
1558 Please submit test reports only with the test form at sourceforge. Three simple
1561 * Select category: the distribution you test on.
1563 * Select group: the version of Privoxy that we are about to release.
1565 * Fill the Summary and Detailed Description with something intelligent (keep
1566 it short and precise).
1568 Do not mail to the mailinglist (we cannot keep track on issues there).
1570 -------------------------------------------------------------------------------
1572 6. Releasing a New Version
1574 When we release versions of Privoxy, our work leaves our cozy secret lab and
1575 has to work in the cold RealWorld[tm]. Once it is released, there is no way to
1576 call it back, so it is very important that great care is taken to ensure that
1577 everything runs fine, and not to introduce problems in the very last minute.
1579 So when releasing a new version, please adhere exactly to the procedure
1580 outlined in this chapter.
1582 The following programs are required to follow this process: ncftpput (ncftp),
1583 scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs.
1585 -------------------------------------------------------------------------------
1587 6.1. Version numbers
1589 First you need to determine which version number the release will have. Privoxy
1590 version numbers consist of three numbers, separated by dots, like in X.Y.Z,
1593 * X, the version major, is rarely ever changed. It is increased by one if
1594 turning a development branch into stable substantially changes the
1595 functionality, user interface or configuration syntax. Majors 1 and 2 were
1596 Junkbuster, and 3 will be the first stable Privoxy release.
1598 * Y, the version minor, represents the branch within the major version. At
1599 any point in time, there are two branches being maintained: The stable
1600 branch, with an even minor, say, 2N, in which no functionality is being
1601 added and only bugfixes are made, and 2N+1, the development branch, in
1602 which the further development of Privoxy takes place. This enables us to
1603 turn the code upside down and inside out, while at the same time providing
1604 and maintaining a stable version. The minor is reset to zero (and one) when
1605 the major is inrcemented. When a development branch has matured to the
1606 point where it can be turned into stable, the old stable branch 2N is given
1607 up (i.e. no longer maintained), the former development branch 2N+1 becomes
1608 the new stable branch 2N+2, and a new development branch 2N+3 is opened.
1610 * Z, the point or sub version, represents a release of the software within a
1611 branch. It is therefore incremented immediately before each code freeze. In
1612 development branches, only the even point versions correspond to actual
1613 releases, while the odd ones denote the evolving state of the sources on
1614 CVS in between. It follows that Z is odd on CVS in development branches
1615 most of the time. There, it gets increased to an even number immediately
1616 before a code freeze, and is increased to an odd number again immediately
1617 thereafter. This ensures that builds from CVS snapshots are easily
1618 distinguished from released versions. The point version is reset to zero
1619 when the minor changes.
1621 -------------------------------------------------------------------------------
1623 6.2. Before the Release: Freeze
1625 The following must be done by one of the developers prior to each new release.
1627 * Make sure that everybody who has worked on the code in the last couple of
1628 days has had a chance to yell "no!" in case they have pending changes/fixes
1629 in their pipelines. Announce the freeze so that nobody will interfere with
1630 last minute changes.
1632 * Increment the version number (point from odd to even in development
1633 branches!) in configure.in.
1635 * If default.action has changed since last release (i.e. software release or
1636 standalone actions file release), bump up its version info to A.B in this
1639 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
1641 Then change the version info in doc/webserver/actions/index.php, line:
1642 '$required_actions_file_version = "A.B";'
1644 * If the HTML documentation is not in sync with the SGML sources you need to
1645 regenerate and upload it to the webserver. (If in doubt, just do it.) See
1646 the Section "Updating the webserver" in this manual for details.
1648 * Commit all files that were changed in the above steps!
1650 * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
1651 use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
1653 * If the release was in a development branch, increase the point version from
1654 even to odd (X.Y.(Z+1)) again in configure.in and commit your change.
1656 * On the webserver, copy the user manual to a new top-level directory called
1657 X.Y.Z. This ensures that help links from the CGI pages, which have the
1658 version as a prefix, will go into the right version of the manual. If this
1659 is a development branch release, also symlink X.Y.(Z-1) to X.Y.Z and X.Y.
1660 (Z+1) to . (i.e. dot).
1662 -------------------------------------------------------------------------------
1664 6.3. Building and Releasing the Packages
1666 Now the individual packages can be built and released. Note that for GPL
1667 reasons the first package to be released is always the source tarball.
1669 For all types of packages, including the source tarball, you must make sure
1670 that you build from clean sources by exporting the right version from CVS into
1671 an empty directory:.
1673 mkdir dist # delete or choose different name if it already exists
1675 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
1676 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
1678 Do NOT change a single bit, including, but not limited to version information
1679 after export from CVS. This is to make sure that all release packages, and with
1680 them, all future bug reports, are based on exactly the same code.
1682 Please find additional instructions for the source tarball and the individual
1683 platform dependent binary packages below.
1685 -------------------------------------------------------------------------------
1687 6.3.1. Source Tarball
1689 First, make sure that you have freshly exported the right version into an empty
1690 directory. (See "Building and releasing packages" above). Then run:
1693 autoheader && autoconf && ./configure
1699 To upload the package to Sourceforge, simply issue
1703 Go to the displayed URL and release the file publicly on Sourceforge. For the
1704 change log field, use the relevant section of the ChangeLog file.
1706 -------------------------------------------------------------------------------
1708 6.3.2. SuSE or Red Hat RPM
1710 In following text, replace dist with either "rh" for Red Hat or "suse" for
1713 First, make sure that you have freshly exported the right version into an empty
1714 directory. (See "Building and releasing packages" above).
1716 As the only exception to not changing anything after export from CVS, now
1717 examine the file privoxy-dist.spec and make sure that the version information
1718 and the RPM release number are correct. The RPM release numbers for each
1719 version start at one. Hence it must be reset to one if this is the first RPM
1720 for dist which is built from version X.Y.Z. Check the file list if unsure.
1721 Else, it must be set to the highest already available RPM release number for
1722 that version plus one.
1727 autoheader && autoconf && ./configure
1733 To upload the package to Sourceforge, simply issue
1735 make dist-upload rpm_packagerev
1737 where rpm_packagerev is the RPM release number as determined above. Go to the
1738 displayed URL and release the file publicly on Sourceforge. Use the release
1739 notes and change log from the source tarball package.
1741 -------------------------------------------------------------------------------
1745 First, make sure that you have freshly exported the right version into an empty
1746 directory. (See "Building and releasing packages" above). Then get the OS/2
1749 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
1751 You will need a mix of development tools. The main compilation takes place with
1752 IBM Visual Age C++. Some ancillary work takes place with GNU tools, available
1753 from various sources like hobbes.nmsu.edu. Specificially, you will need
1754 autoheader, autoconf and sh tools. The packaging takes place with WarpIN,
1755 available from various sources, including its home page: xworkplace.
1757 Change directory to the os2setup directory. Edit the os2build.cmd file to set
1758 the final executable filename. For example,
1760 installExeName='privoxyos2_setup_X.Y.Z.exe'
1762 Next, edit the IJB.wis file so the release number matches in the PACKAGEID
1765 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
1767 You're now ready to build. Run:
1771 You will find the WarpIN-installable executable in the ./files directory.
1772 Upload this anonymously to uploads.sourceforge.net/incoming, create a release
1773 for it, and you're done. Use the release notes and Change Log from the source
1776 -------------------------------------------------------------------------------
1780 Login to Sourceforge's compilefarm via ssh:
1782 ssh cf.sourceforge.net
1784 Choose the right operating system (not the Debian one). When logged in, make
1785 sure that you have freshly exported the right version into an empty directory.
1786 (See "Building and releasing packages" above). Then run:
1789 autoheader && autoconf && ./configure
1795 which creates a gzip'ed tar archive. Sadly, you cannot use make solaris-upload
1796 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1797 archive to Sourceforge's ftp server and release the file publicly. Use the
1798 release notes and Change Log from the source tarball package.
1800 -------------------------------------------------------------------------------
1804 You should ensure you have the latest version of Cygwin (from http://
1805 www.cygwin.com/). Run the following commands from within a Cygwin bash shell.
1807 First, make sure that you have freshly exported the right version into an empty
1808 directory. (See "Building and releasing packages" above). Then get the Windows
1811 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
1813 Then you can build the package. This is fully automated, and is controlled by
1814 winsetup/GNUmakefile. All you need to do is:
1819 Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
1820 upload it to SourceForge. When releasing the package on SourceForge, use the
1821 release notes and Change Log from the source tarball package.
1823 -------------------------------------------------------------------------------
1827 First, make sure that you have freshly exported the right version into an empty
1828 directory. (See "Building and releasing packages" above). Then, run:
1831 autoheader && autoconf && ./configure
1835 -------------------------------------------------------------------------------
1839 First, make sure that you have freshly exported the right version into an empty
1840 directory. (See "Building and releasing packages" above). Then get the Mac OSX
1843 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
1850 This will run autoheader, autoconf and configure as well as make. Finally, it
1851 will copy over the necessary files to the ./osxsetup/files directory for
1852 further processing by PackageMaker.
1854 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the
1855 package name to match the release, and hit the "Create package" button. If you
1856 specify ./Privoxy.pkg as the output package name, you can then create the
1857 distributable zip file with the command:
1859 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
1861 You can then upload privoxyosx_setup_x.y.z.zip anonymously to
1862 uploads.sourceforge.net/incoming, create a release for it, and you're done. Use
1863 the release notes and Change Log from the source tarball package.
1865 -------------------------------------------------------------------------------
1869 Login to Sourceforge's compilefarm via ssh:
1871 ssh cf.sourceforge.net
1873 Choose the right operating system. When logged in, make sure that you have
1874 freshly exported the right version into an empty directory. (See "Building and
1875 releasing packages" above). Then run:
1878 autoheader && autoconf && ./configure
1884 which creates a gzip'ed tar archive. Sadly, you cannot use make freebsd-upload
1885 on the Sourceforge machine (no ncftpput). You now have to manually upload the
1886 archive to Sourceforge's ftp server and release the file publicly. Use the
1887 release notes and Change Log from the source tarball package.
1889 -------------------------------------------------------------------------------
1893 First, make sure that you have freshly exported the right version into an empty
1894 directory. (See "Building and releasing packages" above). Then run:
1897 autoheader && autoconf && ./configure
1901 -------------------------------------------------------------------------------
1905 First, make sure that you have freshly exported the right version into an empty
1906 directory. (See "Building and releasing packages" above). Then run:
1909 autoheader && autoconf && ./configure
1913 -------------------------------------------------------------------------------
1917 Login to Sourceforge's compilefarm via ssh:
1919 ssh cf.sourceforge.net
1921 Choose the right operating system. When logged in, make sure that you have
1922 freshly exported the right version into an empty directory. (See "Building and
1923 releasing packages" above). Then run:
1926 autoheader && autoconf && ./configure
1932 which creates a gzip'ed tar archive. Sadly, you cannot use make aix-upload on
1933 the Sourceforge machine (no ncftpput). You now have to manually upload the
1934 archive to Sourceforge's ftp server and release the file publicly. Use the
1935 release notes and Change Log from the source tarball package.
1937 -------------------------------------------------------------------------------
1939 6.4. Uploading and Releasing Your Package
1941 After the package is ready, it is time to upload it to SourceForge, and go
1942 through the release steps. The upload is done via FTP:
1944 * Upload to: ftp://upload.sourceforge.net/incoming
1948 * password: ijbswa-developers@lists.sourceforge.net
1950 Once this done go to http://sourceforge.net/project/admin/editpackages.php?
1951 group_id=11118, making sure you are logged in. Find your target platform in the
1952 second column, and click Add Release. You will then need to create a new
1953 release for your package, using the format of $VERSION ($CODE_STATUS), e.g.
1956 Now just follow the prompts. Be sure to add any appropriate Release notes. You
1957 should see your freshly uploaded packages in "Step 2. Add Files To This
1958 Release". Check the appropriate box(es). Remember at each step to hit the
1959 "Refresh/Submit" buttons! You should now see your file(s) listed in Step 3.
1960 Fill out the forms with the appropriate information for your platform, being
1961 sure to hit "Update" for each file. If anyone is monitoring your platform,
1962 check the "email" box at the very bottom to notify them of the new package.
1965 If you have made errors, or need to make changes, you can go through
1966 essentially the same steps, but select Edit Release, instead of Add Release.
1968 -------------------------------------------------------------------------------
1970 6.5. After the Release
1972 When all (or: most of the) packages have been uploaded and made available, send
1973 an email to the announce mailing list, Subject: "Version X.Y.Z available for
1974 download". Be sure to include the download location, the release notes and the
1977 -------------------------------------------------------------------------------
1979 7. Update the Webserver
1981 When updating the webserver, please follow these steps to make sure that no
1982 broken links, incosistent contents or permission problems will occur:
1984 If you have changed anything in the documentation source SGML files, do:
1986 make dok # (or make redkat-dok if make dok doesn't work for you)
1988 That will generate doc/webserver/user-manual, doc/webserver/developer-manual,
1989 doc/webserver/faq and doc/webserver/index.html automatically.
1991 If you changed the manual page source, generate doc/webserver/man-page/
1992 privoxy-man-page.html by running "make man". (This is a separate target due to
1993 dependencies on some obscure perl scripts. See comments in GNUmakefile.)
1995 If you want to add new files to the webserver, create them locally in the doc/
1996 webserver/* directory (or create new directories under doc/webserver).
1998 Next, commit any changes from the above steps to CVS. All set? Then do
2002 This will do the upload to the webserver (www.privoxy.org) and ensure all files
2003 and directories there are group writable.
2005 Please do NOT use any other means of transferring files to the webserver to
2006 avoid permission problems.
2008 -------------------------------------------------------------------------------
2010 8. Contacting the developers, Bug Reporting and Feature Requests
2012 We value your feedback. However, to provide you with the best support, please
2013 note the following sections.
2015 -------------------------------------------------------------------------------
2019 To get support, use the Sourceforge Support Forum:
2021 http://sourceforge.net/tracker/?group_id=11118&atid=211118
2023 -------------------------------------------------------------------------------
2027 To submit bugs, use the Sourceforge Bug Forum:
2029 http://sourceforge.net/tracker/?group_id=11118&atid=111118.
2031 Make sure that the bug has not already been submitted. Please try to verify
2032 that it is a Privoxy bug, and not a browser or site bug first. If you are using
2033 your own custom configuration, please try the stock configs to see if the
2034 problem is a configuration related bug. And if not using the latest development
2035 snapshot, please try the latest one. Or even better, CVS sources. Please be
2036 sure to include the Privoxy version, platform, browser, any pertinent log data,
2037 any other relevant details (please be specific) and, if possible, some way to
2040 -------------------------------------------------------------------------------
2042 8.3. Request new features
2044 To submit ideas on new features, use the Sourceforge feature request forum:
2046 http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
2048 -------------------------------------------------------------------------------
2050 8.4. Report ads or other filter problems
2052 You can also send feedback on websites that Privoxy has problems with. Please
2053 bookmark the following link: "Privoxy - Submit Filter Feedback". Once you surf
2054 to a page with problems, use the bookmark to send us feedback. We will look
2055 into the issue as soon as possible.
2057 New, improved default.action files will occasionally be made available based on
2058 your feedback. These will be announced on the ijbswa-announce list.
2060 -------------------------------------------------------------------------------
2064 For any other issues, feel free to use the mailing lists:
2066 http://sourceforge.net/mail/?group_id=11118.
2068 Anyone interested in actively participating in development and related
2069 discussions can also join the appropriate mailing list. Archives are available,
2070 too. See the page on Sourceforge.
2072 -------------------------------------------------------------------------------
2074 9. Privoxy Copyright, License and History
2076 Copyright © 2001, 2002 by Privoxy Developers <developers@privoxy.org>
2078 Some source code is based on code Copyright © 1997 by Anonymous Coders and
2079 Junkbusters, Inc. and licensed under the GNU General Public License.
2081 -------------------------------------------------------------------------------
2085 Privoxy is free software; you can redistribute it and/or modify it under the
2086 terms of the GNU General Public License, version 2, as published by the Free
2087 Software Foundation.
2089 This program is distributed in the hope that it will be useful, but WITHOUT ANY
2090 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
2091 PARTICULAR PURPOSE. See the GNU General Public License for more details, which
2092 is available from the Free Software Foundation, Inc, 59 Temple Place - Suite
2093 330, Boston, MA 02111-1307, USA.
2095 You should have received a copy of the GNU General Public License along with
2096 this program; if not, write to the
2099 Foundation, Inc. 59 Temple Place - Suite 330
2100 Boston, MA 02111-1307
2103 -------------------------------------------------------------------------------
2107 Privoxy is evolved, and derived from, the Internet Junkbuster, with many
2108 improvments and enhancements over the original.
2110 Junkbuster was originally written by Anonymous Coders and Junkbusters
2111 Corporation, and was released as free open-source software under the GNU GPL.
2112 Stefan Waldherr made many improvements, and started the SourceForge project
2113 Privoxy to rekindle development. There are now several active developers
2114 contributing. The last stable release of Junkbuster was v2.0.2, which has now
2117 -------------------------------------------------------------------------------
2121 Other references and sites of interest to Privoxy users:
2123 http://www.privoxy.org/, The Privoxy Home page.
2125 http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on
2128 http://p.p/, access Privoxy from your browser. Alternately, http://
2129 config.privoxy.org may work in some situations where the first does not.
2131 http://p.p/, and select "Privoxy - Submit Filter Feedback" to submit "misses"
2134 http://www.junkbusters.com/ht/en/cookies.html
2136 http://www.waldherr.org/junkbuster/
2138 http://privacy.net/analyze/
2140 http://www.squid-cache.org/
projects / privoxy.git / blob