From 69b45dc21f48175fb34a8e1e2f45d46870e37941 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Thu, 20 Sep 2012 11:22:20 +0000 Subject: [PATCH] Documentation for 3.0.19, regenerated with the modified tidy changes --- doc/webserver/developer-manual/coding.html | 518 ++++++++------- doc/webserver/developer-manual/contact.html | 22 +- doc/webserver/developer-manual/copyright.html | 28 +- doc/webserver/developer-manual/cvs.html | 29 +- .../developer-manual/documentation.html | 140 ++-- doc/webserver/developer-manual/index.html | 64 +- .../developer-manual/introduction.html | 17 +- .../developer-manual/newrelease.html | 390 +++++------ doc/webserver/developer-manual/seealso.html | 17 +- doc/webserver/developer-manual/testing.html | 17 +- .../developer-manual/webserver-update.html | 33 +- doc/webserver/faq/configuration.html | 105 ++- doc/webserver/faq/contact.html | 22 +- doc/webserver/faq/copyright.html | 24 +- doc/webserver/faq/general.html | 106 ++- doc/webserver/faq/index.html | 121 ++-- doc/webserver/faq/installation.html | 22 +- doc/webserver/faq/misc.html | 94 ++- doc/webserver/faq/trouble.html | 50 +- doc/webserver/index.html | 84 ++- doc/webserver/man-page/privoxy-man-page.html | 2 +- doc/webserver/privoxy-index.html | 79 ++- doc/webserver/team/index.html | 2 +- doc/webserver/user-manual/actions-file.html | 625 +++++++++--------- doc/webserver/user-manual/appendix.html | 200 +++--- doc/webserver/user-manual/config.html | 468 ++++++------- doc/webserver/user-manual/configuration.html | 46 +- doc/webserver/user-manual/contact.html | 26 +- doc/webserver/user-manual/copyright.html | 39 +- doc/webserver/user-manual/filter-file.html | 274 ++++---- doc/webserver/user-manual/index.html | 149 ++--- doc/webserver/user-manual/installation.html | 210 ++---- doc/webserver/user-manual/introduction.html | 44 +- doc/webserver/user-manual/quickstart.html | 69 +- doc/webserver/user-manual/seealso.html | 21 +- doc/webserver/user-manual/startup.html | 119 ++-- doc/webserver/user-manual/templates.html | 37 +- doc/webserver/user-manual/whatsnew.html | 21 +- 38 files changed, 1972 insertions(+), 2362 deletions(-) diff --git a/doc/webserver/developer-manual/coding.html b/doc/webserver/developer-manual/coding.html index 39aea1ad..0855d86f 100644 --- a/doc/webserver/developer-manual/coding.html +++ b/doc/webserver/developer-manual/coding.html @@ -12,21 +12,10 @@ - - +
@@ -73,7 +62,8 @@ body {

4.2.1. Comment, Comment, Comment

-

Explanation:

+

Explanation:

Comment as much as possible without commenting the obvious. For example do not comment "variable_a is equal to variable_b". Instead @@ -88,9 +78,9 @@ body { comment describes something different than what the code is doing then maybe a programming error is occurring.

-

Example:

+

Example:

- +
@@ -119,7 +109,8 @@ is actually being done.
         

4.2.2. Use blocks for comments

-

Explanation:

+

Explanation:

Comments can help or they can clutter. They help when they are differentiated from the code they describe. One line comments do not @@ -127,9 +118,9 @@ is actually being done. identifiers do, by surrounding the code with a clear, definable pattern.

-

Example:

+

Example:

- +
@@ -158,7 +149,8 @@ if ( this_variable == that_variable ) /* this may not either */
           
-

Exception:

+

Exception:

If you are trying to add a small logic comment and do not wish to "disrupt" the flow of the code, feel free to use a 1 line comment @@ -169,7 +161,8 @@ if ( this_variable == that_variable ) /* this may not either */

4.2.3. Keep Comments on their own line

-

Explanation:

+

Explanation:

It goes back to the question of readability. If the comment is on the same line as the code it will be harder to read than the comment @@ -179,9 +172,9 @@ if ( this_variable == that_variable ) /* this may not either */ freely and often: during the definition of variables, at the end of closing braces, when used to comment parameters.

-

Example:

+

Example:

- +
@@ -229,7 +222,8 @@ short do_something_very_important(
         

4.2.4. Comment each logical step

-

Explanation:

+

Explanation:

Logical steps should be commented to help others follow the intent of the written code and comments will make the code more @@ -246,7 +240,8 @@ short do_something_very_important(

4.2.5. Comment All Functions Thoroughly

-

Explanation:

+

Explanation:

A reader of the code should be able to look at the comments just prior to the beginning of a function and discern the reason for its @@ -265,7 +260,8 @@ short do_something_very_important(

4.2.6. Comment at the end of braces if the content is more than one screen length

-

Explanation:

+

Explanation:

Each closing brace should be followed on the same line by a comment that describes the origination of the brace if the original @@ -279,9 +275,9 @@ short do_something_very_important(

use following a closing brace: } /* -END- if() or while () or etc... */

-

Example:

+

Example:

- +
@@ -312,7 +308,8 @@ if ( 1 == X )
         

4.3.1. Variable Names

-

Explanation:

+

Explanation:

Use all lowercase, and separate words via an underscore ('_'). Do not start an identifier with an underscore. (ANSI C reserves these @@ -320,9 +317,9 @@ if ( 1 == X ) which are reserved in ANSI C++. (E.g. template, class, true, false, ...). This is in case we ever decide to port Privoxy to C++.

-

Example:

+

Example:

- +
@@ -332,9 +329,10 @@ int ms_iis5_hack = 0;
           
-

Instead of:

+

Instead + of:

- +
@@ -349,7 +347,8 @@ int msiis5hack = 0; int msIis5Hack = 0;
         

4.3.2. Function Names

-

Explanation:

+

Explanation:

Use all lowercase, and separate words via an underscore ('_'). Do not start an identifier with an underscore. (ANSI C reserves these @@ -357,9 +356,9 @@ int msiis5hack = 0; int msIis5Hack = 0; which are reserved in ANSI C++. (E.g. template, class, true, false, ...). This is in case we ever decide to port Privoxy to C++.

-

Example:

+

Example:

- +
@@ -369,9 +368,10 @@ int load_some_file( struct client_state *csp )
           
-

Instead of:

+

Instead + of:

- +
@@ -387,15 +387,16 @@ int loadSomeFile( struct client_state *csp )
         

4.3.3. Header file prototypes

-

Explanation:

+

Explanation:

Use a descriptive parameter name in the function prototype in header files. Use the same parameter name in the header file that you use in the c file.

-

Example:

+

Example:

- +
@@ -406,9 +407,10 @@ int loadSomeFile( struct client_state *csp )
           
-

Instead of:

+

Instead + of:

- +
@@ -425,15 +427,16 @@ int loadSomeFile( struct client_state *csp )
         

4.3.4. Enumerations, and #defines

-

Explanation:

+

Explanation:

Use all capital letters, with underscores between words. Do not start an identifier with an underscore. (ANSI C reserves these for use by the compiler and system headers.)

-

Example:

+

Example:

- +
@@ -444,14 +447,14 @@ int loadSomeFile( struct client_state *csp )
           
-

Note: We have a standard - naming scheme for #defines that toggle a feature in the preprocessor: - FEATURE_>, where > is a short (preferably 1 or 2 word) - description.

+

Note: We + have a standard naming scheme for #defines that toggle a feature in + the preprocessor: FEATURE_>, where > is a short (preferably 1 + or 2 word) description.

-

Example:

+

Example:

- +
@@ -469,7 +472,8 @@ int loadSomeFile( struct client_state *csp )
       

4.3.5. Constants

-

Explanation:

+

Explanation:

Spell common words out entirely (do not remove vowels).

@@ -479,9 +483,9 @@ int loadSomeFile( struct client_state *csp )

Use underscore (_) to separate adjacent acronyms and abbreviations. Never terminate a name with an underscore.

-

Example:

+

Example:

- +
@@ -491,9 +495,10 @@ int loadSomeFile( struct client_state *csp )
           
-

Instead of:

+

Instead + of:

- +
@@ -516,16 +521,17 @@ int loadSomeFile( struct client_state *csp )
         

4.4.1. Put braces on a line by themselves.

-

Explanation:

+

Explanation:

The brace needs to be on a line all by itself, not at the end of the statement. Curly braces should line up with the construct that they're associated with. This practice makes it easier to identify the opening and closing braces for a block.

-

Example:

+

Example:

- +
@@ -538,7 +544,8 @@ if ( this == that )
           
-

Instead of:

+

Instead + of:

if ( this == that ) { ... }

@@ -546,18 +553,19 @@ if ( this == that )

if ( this == that ) { ... }

-

Note: In the special - case that the if-statement is inside a loop, and it is trivial, i.e. - it tests for a condition that is obvious from the purpose of the - block, one-liners as above may optically preserve the loop structure - and make it easier to read.

+

Note: In the + special case that the if-statement is inside a loop, and it is + trivial, i.e. it tests for a condition that is obvious from the + purpose of the block, one-liners as above may optically preserve the + loop structure and make it easier to read.

-

Status: +

Status: developer-discretion.

-

Example exception:

+

Example + exception:

- +
@@ -578,15 +586,16 @@ while ( more lines are read )
         

4.4.2. ALL control statements should have a block

-

Explanation:

+

Explanation:

Using braces to make a block will make your code more readable and less prone to error. All control statements should have a block defined.

-

Example:

+

Example:

- +
@@ -600,7 +609,8 @@ if ( this == that )
           
-

Instead of:

+

Instead + of:

if ( this == that ) do_something(); do_something_else();

@@ -608,20 +618,20 @@ if ( this == that )

if ( this == that ) do_something();

-

Note: The first example - in "Instead of" will execute in a manner other than that which the - developer desired (per indentation). Using code braces would have - prevented this "feature". The "explanation" and "exception" from the - point above also applies.

+

Note: The + first example in "Instead of" will execute in a manner other than + that which the developer desired (per indentation). Using code braces + would have prevented this "feature". The "explanation" and + "exception" from the point above also applies.

4.4.3. Do not belabor/blow-up boolean expressions

-

Example:

+

Example:

- +
@@ -631,30 +641,32 @@ structure->flag = ( condition );
           
-

Instead of:

+

Instead + of:

if ( condition ) { structure->flag = 1; } else { structure->flag = 0; }

-

Note: The former is - readable and concise. The later is wordy and inefficient. Please - assume that any developer new to the project has at least a "good" - knowledge of C/C++. (Hope I do not offend by that last comment ... - 8-)

+

Note: The + former is readable and concise. The later is wordy and inefficient. + Please assume that any developer new to the project has at least a + "good" knowledge of C/C++. (Hope I do not offend by that last comment + ... 8-)

4.4.4. Use white space freely because it is free

-

Explanation:

+

Explanation:

Make it readable. The notable exception to using white space freely is listed in the next guideline.

-

Example:

+

Example:

- +
@@ -676,7 +688,8 @@ first_value = old_value + ( ( some_value - another_value ) - whatever )
         

4.4.5. Don't use white space around structure operators

-

Explanation:

+

Explanation:

- structure pointer operator ( "->" ) - member operator ( "." ) - functions and parentheses

@@ -685,9 +698,9 @@ first_value = old_value + ( ( some_value - another_value ) - whatever ) function parentheses next to names. With spaces, the connection between the object and variable/function name is not as clear.

-

Example:

+

Example:

- +
@@ -699,17 +712,17 @@ function_name();
           
-

Instead of: a_struct - -> a_member; a_struct . a_member; function_name ();

+

Instead of: + a_struct -> a_member; a_struct . a_member; function_name ();

4.4.6. Make the last brace of a function stand out

-

Example:

+

Example:

- +
@@ -729,20 +742,21 @@ int function2( ... )
           
-

Instead of:

+

Instead + of:

int function1( ... ) { ...code... return( ret_code ); } int function2( ... ) { }

-

Note: Use 1 blank line - before the closing brace and 2 lines afterward. This makes the end of - function standout to the most casual viewer. Although function - comments help separate functions, this is still a good coding - practice. In fact, I follow these rules when using blocks in "for", - "while", "do" loops, and long if {} statements too. After all +

Note: Use 1 + blank line before the closing brace and 2 lines afterward. This makes + the end of function standout to the most casual viewer. Although + function comments help separate functions, this is still a good + coding practice. In fact, I follow these rules when using blocks in + "for", "while", "do" loops, and long if {} statements too. After all whitespace is free!

-

Status: +

Status: developer-discretion on the number of blank lines. Enforced is the end of function comments.

@@ -751,16 +765,17 @@ int function2( ... )

4.4.7. Use 3 character indentions

-

Explanation:

+

Explanation:

If some use 8 character TABs and some use 3 character TABs, the code can look *very* ragged. So use 3 character indentions only. If you like to use TABs, pass your code through a filter such as "expand -t3" before checking in your code.

-

Example:

+

Example:

- +
@@ -798,15 +813,16 @@ int function1( ... )
         

4.5.1. Initialize all variables

-

Explanation:

+

Explanation:

Do not assume that the variables declared will not be used until after they have been assigned a value somewhere else in the code. Remove the chance of accidentally using an unassigned variable.

-

Example:

+

Example:

- +
@@ -818,12 +834,12 @@ struct *ptr = NULL;
           
-

Note: It is much easier - to debug a SIGSEGV if the message says you are trying to access - memory address 00000000 and not 129FA012; or array_ptr[20] causes a - SIGSEV vs. array_ptr[0].

+

Note: It is + much easier to debug a SIGSEGV if the message says you are trying to + access memory address 00000000 and not 129FA012; or array_ptr[20] + causes a SIGSEV vs. array_ptr[0].

-

Status: +

Status: developer-discretion if and only if the variable is assigned a value "shortly after" declaration.

@@ -836,14 +852,15 @@ struct *ptr = NULL;

4.6.1. Name functions that return a boolean as a question.

-

Explanation:

+

Explanation:

Value should be phrased as a question that would logically be answered as a true or false statement

-

Example:

+

Example:

- +
@@ -860,7 +877,8 @@ is_web_page_blank();
         

4.6.2. Always specify a return type for a function.

-

Explanation:

+

Explanation:

The default return for a function is an int. To avoid ambiguity, create a return for a function when the return has a purpose, and @@ -872,14 +890,15 @@ is_web_page_blank();

4.6.3. Minimize function calls when iterating by using variables

-

Explanation:

+

Explanation:

It is easy to write the following code, and a clear argument can be made that the code is easy to understand:

-

Example:

+

Example:

- +
@@ -892,22 +911,22 @@ for ( size_t cnt = 0; cnt < block_list_length(); cnt++ )
           
-

Note: Unfortunately, - this makes a function call for each and every iteration. This - increases the overhead in the program, because the compiler has to - look up the function each time, call it, and return a value. - Depending on what occurs in the block_list_length() call, it might - even be creating and destroying structures with each iteration, even - though in each case it is comparing "cnt" to the same value, over and - over. Remember too - even a call to block_list_length() is a function - call, with the same overhead.

+

Note: + Unfortunately, this makes a function call for each and every + iteration. This increases the overhead in the program, because the + compiler has to look up the function each time, call it, and return a + value. Depending on what occurs in the block_list_length() call, it + might even be creating and destroying structures with each iteration, + even though in each case it is comparing "cnt" to the same value, + over and over. Remember too - even a call to block_list_length() is a + function call, with the same overhead.

Instead of using a function call during the iterations, assign the value to a variable, and evaluate using the variable.

-

Example:

+

Example:

- +
@@ -922,16 +941,18 @@ for ( size_t cnt = 0; cnt < len; cnt++ )
           
-

Exceptions: if the value - of block_list_length() *may* change or could *potentially* change, - then you must code the function call in the for/while loop.

+

Exceptions: + if the value of block_list_length() *may* change or could + *potentially* change, then you must code the function call in the + for/while loop.

4.6.4. Pass and Return by Const Reference

-

Explanation:

+

Explanation:

This allows a developer to define a const pointer and call your function. If your function does not have the const keyword, we may @@ -949,7 +970,8 @@ for ( size_t cnt = 0; cnt < len; cnt++ )

4.6.5. Pass and Return by Value

-

Explanation:

+

Explanation:

Most structures cannot fit onto a normal stack entry (i.e. they are not 4 bytes or less). Aka, a function declaration like: int @@ -964,7 +986,8 @@ for ( size_t cnt = 0; cnt < len; cnt++ )

4.6.6. Names of include files

-

Explanation:

+

Explanation:

Your include statements should contain the file name without a path. The path should be listed in the Makefile, using -I as @@ -973,9 +996,9 @@ for ( size_t cnt = 0; cnt < len; cnt++ ) path to distinguish their header files from system or other header files.

-

Example:

+

Example:

- +
@@ -986,9 +1009,10 @@ for ( size_t cnt = 0; cnt < len; cnt++ )
           
-

Exception:

+

Exception:

- +
@@ -999,16 +1023,17 @@ for ( size_t cnt = 0; cnt < len; cnt++ )
           
-

Note: Please! do not add - "-I." to the Makefile without a _very_ good reason. This duplicates - the #include "file.h" behavior.

+

Note: + Please! do not add "-I." to the Makefile without a _very_ good + reason. This duplicates the #include "file.h" behavior.

4.6.7. Provide multiple inclusion protection

-

Explanation:

+

Explanation:

Prevents compiler and linker errors resulting from redefinition of items.

@@ -1017,9 +1042,9 @@ for ( size_t cnt = 0; cnt < len; cnt++ ) multiple inclusions of the file. Of course, replace PROJECT_H with your file name, with "." Changed to "_", and make it uppercase.

-

Example:

+

Example:

- +
@@ -1037,15 +1062,16 @@ for ( size_t cnt = 0; cnt < len; cnt++ )
         

4.6.8. Use `extern "C"` when appropriate

-

Explanation:

+

Explanation:

If our headers are included from C++, they must declare our functions as `extern "C"`. This has no cost in C, but increases the potential re-usability of our code.

-

Example:

+

Example:

- +
@@ -1069,14 +1095,15 @@ extern "C"
         

4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes

-

Explanation:

+

Explanation:

Useful in headers that include pointers to other struct's. Modifications to excess header files may cause needless compiles.

-

Example:

+

Example:

- +
@@ -1090,13 +1117,13 @@ extern file_list *xyz;
           
-

Note: If you declare - "file_list xyz;" (without the pointer), then including the proper - header file is necessary. If you only want to prototype a pointer, - however, the header file is unnecessary.

+

Note: If you + declare "file_list xyz;" (without the pointer), then including the + proper header file is necessary. If you only want to prototype a + pointer, however, the header file is unnecessary.

-

Status: Use with - discretion.

+

Status: Use + with discretion.

@@ -1108,7 +1135,8 @@ extern file_list *xyz;

4.7.1. Turn on warnings

-

Explanation

+

Explanation

Compiler warnings are meant to help you find bugs. You should turn on as many as possible. With GCC, the switch is "-Wall". Try and fix @@ -1119,16 +1147,17 @@ extern file_list *xyz;

4.7.2. Provide a default case for all switch statements

-

Explanation:

+

Explanation:

What you think is guaranteed is never really guaranteed. The value that you don't think you need to check is the one that someday will be passed. So, to protect yourself from the unknown, always have a default step in a switch statement.

-

Example:

+

Example:

- +
@@ -1153,27 +1182,28 @@ switch( hash_string( cmd ) )
           
-

Note: If you already - have a default condition, you are obviously exempt from this point. - Of note, most of the WIN32 code calls `DefWindowProc' after the - switch statement. This API call *should* be included in a default +

Note: If you + already have a default condition, you are obviously exempt from this + point. Of note, most of the WIN32 code calls `DefWindowProc' after + the switch statement. This API call *should* be included in a default statement.

-

Another Note: This is - not so much a readability issue as a robust programming issue. The - "anomaly code goes here" may be no more than a print to the STDERR - stream (as in load_config). Or it may really be an abort - condition.

+

Another + Note: This is not so much a readability issue as a robust + programming issue. The "anomaly code goes here" may be no more than a + print to the STDERR stream (as in load_config). Or it may really be + an abort condition.

-

Status: Programmer - discretion is advised.

+

Status: + Programmer discretion is advised.

4.7.3. Try to avoid falling through cases in a switch statement.

-

Explanation:

+

Explanation:

In general, you will want to have a 'break' statement within each 'case' of a switch statement. This allows for the code to be more @@ -1196,23 +1226,25 @@ switch( hash_string( cmd ) )

4.7.4. Use 'long' or 'short' Instead of 'int'

-

Explanation:

+

Explanation:

On 32-bit platforms, int usually has the range of long. On 16-bit platforms, int has the range of short.

-

Status: open-to-debate. - In the case of most FSF projects (including X/GNU-Emacs), there are - typedefs to int4, int8, int16, (or equivalence ... I forget the exact - typedefs now). Should we add these to IJB now that we have a - "configure" script?

+

Status: + open-to-debate. In the case of most FSF projects (including + X/GNU-Emacs), there are typedefs to int4, int8, int16, (or + equivalence ... I forget the exact typedefs now). Should we add these + to IJB now that we have a "configure" script?

4.7.5. Don't mix size_t and other types

-

Explanation:

+

Explanation:

The type of size_t varies across platforms. Do not make assumptions about whether it is signed or unsigned, or about how long @@ -1225,14 +1257,15 @@ switch( hash_string( cmd ) )

4.7.6. Declare each variable and struct on its own line.

-

Explanation:

+

Explanation:

It can be tempting to declare a series of variables all on one line. Don't.

-

Example:

+

Example:

- +
@@ -1244,22 +1277,23 @@ long c = 0;
           
-

Instead of:

+

Instead + of:

long a, b, c;

-

Explanation: - there is - more room for comments on the individual variables - easier to add - new variables without messing up the original ones - when searching - on a variable to find its type, there is less clutter to "visually" - eliminate

+

Explanation: + - there is more room for comments on the individual variables - + easier to add new variables without messing up the original ones - + when searching on a variable to find its type, there is less clutter + to "visually" eliminate

-

Exceptions: when you - want to declare a bunch of loop variables or other trivial variables; - feel free to declare them on one line. You should, although, provide - a good comment on their functions.

+

Exceptions: + when you want to declare a bunch of loop variables or other trivial + variables; feel free to declare them on one line. You should, + although, provide a good comment on their functions.

-

Status: +

Status: developer-discretion.

@@ -1267,7 +1301,8 @@ long c = 0;

4.7.7. Use malloc/zalloc sparingly

-

Explanation:

+

Explanation:

Create a local struct (on the stack) if the variable will live and die within the context of one function call.

@@ -1275,9 +1310,9 @@ long c = 0;

Only "malloc" a struct (on the heap) if the variable's life will extend beyond the context of one function call.

-

Example:

+

Example:

- +
@@ -1293,7 +1328,8 @@ list, then it should definitely be allocated via `malloc'.
         

4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'

-

Explanation:

+

Explanation:

If you have to "malloc" an instance, you are responsible for insuring that the instance is `free'd, even if the deallocation event @@ -1303,9 +1339,9 @@ list, then it should definitely be allocated via `malloc'. You may need to offer a free/unload/destructor type function to accommodate this.

-

Example:

+

Example:

- +
@@ -1316,12 +1352,13 @@ static void unload_re_filterfile( void *f ) { ... }
           
-

Exceptions:

+

Exceptions:

The developer cannot be expected to provide `free'ing functions for C run-time library functions ... such as `strdup'.

-

Status: +

Status: developer-discretion. The "main" use of this standard is for allocating and freeing data structures (complex or nested).

@@ -1330,23 +1367,25 @@ static void unload_re_filterfile( void *f ) { ... }

4.7.9. Add loaders to the `file_list' structure and in order

-

Explanation:

+

Explanation:

I have ordered all of the "blocker" file code to be in alpha order. It is easier to add/read new blockers when you expect a certain order.

-

Note: It may appear that - the alpha order is broken in places by POPUP tests coming before PCRS - tests. But since POPUPs can also be referred to as KILLPOPUPs, it is - clear that it should come first.

+

Note: It may + appear that the alpha order is broken in places by POPUP tests coming + before PCRS tests. But since POPUPs can also be referred to as + KILLPOPUPs, it is clear that it should come first.

4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME or XXX

-

Explanation:

+

Explanation:

If you have enough confidence in new code or confidence in your changes, but are not *quite* sure of the repercussions, add this:

@@ -1365,10 +1404,10 @@ static void unload_re_filterfile( void *f ) { ... }

/* FIXME: new code that *may* break something else... */ ...new code here...

-

Note: If you make it - clear that this may or may not be a "good thing (tm)", it will be - easier to identify and include in the project (or conversely exclude - from the project).

+

Note: If you + make it clear that this may or may not be a "good thing (tm)", it + will be easier to identify and include in the project (or conversely + exclude from the project).

@@ -1376,10 +1415,10 @@ static void unload_re_filterfile( void *f ) { ... }

4.8. Addendum: Template for files and function comment blocks:

-

Example for file - comments:

+

Example for file + comments:

- +
@@ -1425,21 +1464,22 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
         
-

Note: This declares the - rcs variables that should be added to the "show-proxy-args" page. If - this is a brand new creation by you, you are free to change the - "Copyright" section to represent the rights you wish to maintain.

+

Note: This + declares the rcs variables that should be added to the + "show-proxy-args" page. If this is a brand new creation by you, you are + free to change the "Copyright" section to represent the rights you wish + to maintain.

-

Note: The formfeed - character that is present right after the comment flower box is handy - for (X|GNU)Emacs users to skip the verbiage and get to the heart of the - code (via `forward-page' and `backward-page'). Please include it if you - can.

+

Note: The + formfeed character that is present right after the comment flower box + is handy for (X|GNU)Emacs users to skip the verbiage and get to the + heart of the code (via `forward-page' and `backward-page'). Please + include it if you can.

-

Example for file header - comments:

+

Example for file header + comments:

- +
@@ -1507,10 +1547,10 @@ extern const char FILENAME_h_rcs[];
         
-

Example for function - comments:

+

Example for function + comments:

- +
@@ -1538,14 +1578,14 @@ int FUNCTION_NAME( void *param1, const char *x )
         
-

Note: If we all follow - this practice, we should be able to parse our code to create a - "self-documenting" web page.

+

Note: If we + all follow this practice, we should be able to parse our code to create + a "self-documenting" web page.

@@ -150,8 +140,8 @@ body { "_top">http://sourceforge.net/tracker/?group_id=11118&atid=111118.

Before doing so, please make sure that the bug has not already been submitted and observe - the additional hints at the top of the not already been submitted + and observe the additional hints at the top of the submit form. If already submitted, please feel free to add any info to the original report that might help to solve the @@ -330,7 +320,7 @@ body {

@@ -60,7 +50,7 @@ body { "CITETITLE">GNU General Public License.

-

9.1. License

+

9.1. License

Privoxy is free software; you can redistribute it and/or modify it under the terms of the This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.

+ "_top">GNU General Public License for + details.

You should have received a copy of the GNU GPL along with this program; if not, write to the

@@ -86,7 +76,7 @@ body {
-

9.2. History

+

9.2. History

A long time ago, there was the

@@ -90,8 +80,8 @@ body { (e.g. 3.0.x), a branch is created just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc). Once the initial stable release of any stable branch has taken place, this branch is only used for bugfixes, which have had - prior testing before being committed to CVS. (See only used for bugfixes, which + have had prior testing before being committed to CVS. (See Version Numbers below for details on versioning.)

@@ -122,9 +112,10 @@ body {
  • Your commit message should give a concise overview of - what you changed (no big - details) and why you changed - it Just check previous messages for good examples.

    + what you + changed (no big details) and why you changed it Just + check previous messages for good examples.

  • @@ -157,7 +148,7 @@ body {
  • @@ -56,10 +45,10 @@ body { DTD's and the Docbook modular stylesheets (or comparable alternatives), and either jade or openjade (recommended) installed in order to build - docs from source. Currently there is user-manual, FAQ, and, of - course this, the developer-manual in this + docs from source. Currently there is user-manual, FAQ, and, + of course this, the developer-manual in this format. The README, AUTHORS, INSTALL, privoxy.1 (man page), and config @@ -69,8 +58,9 @@ body { "FILENAME">index.html (and a variation on this file, privoxy-index.html, meant for inclusion with doc packages), are maintained as SGML as well. DO NOT edit these directly. Edit the SGML - source, or contact someone involved in the documentation.

    + "emphasis">DO NOT edit these directly. + Edit the SGML source, or contact someone involved in the + documentation.

    config requires some special handling. The reason it is maintained this way is so that the extensive comments in the @@ -125,9 +115,10 @@ body { "FILENAME">doc/webserver/*/*.html) so that those without the ability to build them locally, have access to them if needed. This is especially important just prior to a new release! Please do this after the $VERSION - and other release specific data in configure.in - has been updated (this is done just prior to a new release).

    + "emphasis">after the $VERSION and other release specific data in configure.in has been updated (this is done just prior to + a new release).

    3.1. Quickstart to Docbook @@ -172,65 +163,65 @@ body { - + - + - + - + - - - + - - + - +
    <para></para>, - paragraph delimiter. Most text needs to be within paragraph - elements (there are some exceptions).<para></para>, paragraph + delimiter. Most text needs to be within paragraph elements (there + are some exceptions).
    <emphasis></emphasis>, - the stylesheets make this italics.<emphasis></emphasis>, the + stylesheets make this italics.
    <filename></filename>, - files and directories.<filename></filename>, files + and directories.
    <command></command>, - command examples.<command></command>, command + examples.
    <literallayout></literallayout>, + <literallayout></literallayout>, like <pre>, more or less.
    <itemizedlist></itemizedlist>, + <itemizedlist></itemizedlist>, list with bullets.
    <listitem></listitem>, - member of the above.<listitem></listitem>, member + of the above.
    <screen></screen>, - screen output, implies <screen></screen>, screen + output, implies <literallayout>.
    <ulink - url="example.com"></ulink>, like HTML <a> tag.<ulink + url="example.com"></ulink>, like HTML + <a> tag.
    <quote></quote>, for, - doh, quoting text.<quote></quote>, for, doh, + quoting text.
    @@ -260,9 +251,9 @@ body {
  • -

    Tags delimiting a block of text (even small blocks) - should be on their own line. Like:

    +

    Tags delimiting a block of text (even small blocks) should be + on their own line. Like:

     <para>
      Some text goes here.
    @@ -357,9 +348,9 @@ body { with generic text, that is used by multiple docs. This way we can write something once, and use it repeatedly without having to re-write the same content over and over again. If editing such a file, keep in mind - that it should be generic. - That is the purpose; so it can be used in varying contexts without - additional modifications.

    + that it should be generic. That is the purpose; so it can be used + in varying contexts without additional modifications.

    We are also using what Docbook calls "internal entities". These are like @@ -394,33 +385,36 @@ body { - + - - + - + - +
    p-version: the - Privoxy version string, e.g. - "3.0.20".p-version: the Privoxy version string, e.g. + "3.0.19".
    p-status: the - project status, either "alpha", - "beta", or p-status: the project status, either + "alpha", "beta", or "stable".
    p-not-stable: - use to conditionally include text in "not - stable" releases (e.g. "beta").p-not-stable: use to conditionally + include text in "not stable" + releases (e.g. "beta").
    p-stable: just - the opposite.p-stable: just the opposite.
    p-text: this - doc is only generated as text.p-text: this doc is only generated as + text.
    @@ -433,7 +427,7 @@ body {

  • @@ -84,7 +75,7 @@ body {
    @@ -121,9 +108,9 @@ body { being committed. Stable branches will then have their version reported as 0.0.0, during that period between releases when changes are being added. This is to denote - that this code is not for - release. Then as the release nears, the version is bumped - according: e.g. 3.0.1 -> 0.0.0 -> + that this code is not + for release. Then as the release nears, the version is + bumped according: e.g. 3.0.1 -> 0.0.0 -> 3.0.2.

    @@ -140,15 +127,15 @@ body { -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable branch. 3.1.x is currently the main trunk, and where work on 3.2.x is taking place. If any questions, please post to the devel list - before committing to a stable - branch!

    + before committing + to a stable branch!

    Developers should remember too that if they commit a bugfix to the stable branch, this will more than likely require a separate submission to the main trunk, since these are separate development trees within CVS. If you are working on both, then this would require at least two - separate check outs (i.e main trunk, and the stable release branch, which is + separate check outs (i.e main trunk, and the stable release branch, which is v_3_0_branch at the moment).

    @@ -156,8 +143,8 @@ body {

    6.2. Before the Release: Freeze

    -

    The following must be done by one - of the developers prior to each new release.

    +

    The following must be + done by one of the developers prior to each new release.