X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fdeveloper-manual.sgml;h=f6b892d064a799c13f0844d6f8f0ecbd8ce1d8b5;hp=99822a6868895c63310acae5b6d66def6b8c9f29;hb=c7277a8982dd2acb7a60877c7b903674bcfc3c34;hpb=3a9fe80117f9fb04210447e1df342c9322992405
diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index 99822a68..f6b892d0 100644
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -5,10 +5,7 @@
-
-
-
-
+
@@ -24,9 +21,9 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 2.43 2012/03/20 13:04:03 fabiankeil Exp $
+ $Id: developer-manual.sgml,v 2.66 2016/02/02 13:08:55 fabiankeil Exp $
- Copyright (C) 2001-2012 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/
See LICENSE.
========================================================================
@@ -45,13 +42,14 @@
- Copyright &my-copy; 2001-2009 by
+ Copyright
+ &my-copy; 2001-2016 by
Privoxy Developers
- $Id: developer-manual.sgml,v 2.43 2012/03/20 13:04:03 fabiankeil Exp $
+ $Id: developer-manual.sgml,v 2.66 2016/02/02 13:08:55 fabiankeil Exp $
@@ -369,9 +368,8 @@ Hal.
Formal documents are built with the Makefile targets of
- make dok, or alternately
- make redhat-dok. If you have problems,
- try both. The build process uses the document SGML sources in
+ make dok.
+ The build process uses the document SGML sources in
doc/source/*/* to update all text files in
doc/text/ and to update all HTML
documents in doc/webserver/.
@@ -386,9 +384,7 @@ Hal.
First, build the docs by running make
- dok (or alternately make
- redhat-dok). For PDF docs, do make
- dok-pdf.
+ dok.
Run make webserver which copies all
@@ -732,7 +728,7 @@ Hal.
understand why or what is being done. A reader may spend a lot
more time figuring out what is going on when a simple comment
or explanation would have prevented the extra research. Please
- help your brother IJB'ers out!
+ help your fellow Privoxy developers out!
The comments will also help justify the intent of the code.
If the comment describes something different than what the code
@@ -741,13 +737,13 @@ Hal.
Example:
/* if page size greater than 1k ... */
-if ( page_length() > 1024 )
+if (page_length() > 1024)
{
... "block" the page up ...
}
/* if page size is small, send it in blocks */
-if ( page_length() > 1024 )
+if (page_length() > 1024)
{
... "block" the page up ...
}
@@ -775,20 +771,20 @@ is actually being done.
/*********************************************************************
* This will stand out clearly in your code!
*********************************************************************/
-if ( this_variable == that_variable )
+if (this_variable == that_variable)
{
do_something_very_important();
}
/* unfortunately, this may not */
-if ( this_variable == that_variable )
+if (this_variable == that_variable)
{
do_something_very_important();
}
-if ( this_variable == that_variable ) /* this may not either */
+if (this_variable == that_variable) /* this may not either */
{
do_something_very_important();
}
@@ -822,12 +818,12 @@ if ( this_variable == that_variable ) /* this may not either */
* This will stand out clearly in your code,
* But the second example won't.
*********************************************************************/
-if ( this_variable == this_variable )
+if (this_variable == this_variable)
{
do_something_very_important();
}
-if ( this_variable == this_variable ) /*can you see me?*/
+if (this_variable == this_variable) /*can you see me?*/
{
do_something_very_important(); /*not easily*/
}
@@ -839,7 +835,7 @@ if ( this_variable == this_variable ) /*can you see me?*/
int urls_read = 0; /* # of urls read + rejected */
int urls_rejected = 0; /* # of urls rejected */
-if ( 1 == X )
+if (1 == X)
{
do_something_very_important();
}
@@ -916,7 +912,7 @@ short do_something_very_important(
Example:
-if ( 1 == X )
+if (1 == X)
{
do_something_very_important();
...some long list of commands...
@@ -924,11 +920,11 @@ if ( 1 == X )
or:
-if ( 1 == X )
+if (1 == X)
{
do_something_very_important();
...some long list of commands...
-} /* -END- if ( 1 == X ) */
+} /* -END- if (1 == X) */
@@ -978,14 +974,14 @@ int msiis5hack = 0; int msIis5Hack = 0;
Example:
-int load_some_file( struct client_state *csp )
+int load_some_file(struct client_state *csp)
Instead of:
-int loadsomefile( struct client_state *csp )
-int loadSomeFile( struct client_state *csp )
+int loadsomefile(struct client_state *csp)
+int loadSomeFile(struct client_state *csp)
@@ -1003,14 +999,14 @@ int loadSomeFile( struct client_state *csp )
Example:
-(.h) extern int load_aclfile( struct client_state *csp );
-(.c) int load_aclfile( struct client_state *csp )
+(.h) extern int load_aclfile(struct client_state *csp);
+(.c) int load_aclfile(struct client_state *csp)
Instead of:
-(.h) extern int load_aclfile( struct client_state * ); or
+(.h) extern int load_aclfile(struct client_state *); or
(.h) extern int load_aclfile();
-(.c) int load_aclfile( struct client_state *csp )
+(.c) int load_aclfile(struct client_state *csp)
@@ -1028,7 +1024,7 @@ int loadSomeFile( struct client_state *csp )
Example:
-(enumeration) : enum Boolean { FALSE, TRUE };
+(enumeration) : enum Boolean {FALSE, TRUE};
(#define) : #define DEFAULT_SIZE 100;
Note: We have a standard naming scheme for #defines
@@ -1096,18 +1092,18 @@ int loadSomeFile( struct client_state *csp )
Example:
-if ( this == that )
+if (this == that)
{
...
}
Instead of:
- if ( this == that ) { ... }
+ if (this == that) { ... }
or
- 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
@@ -1119,12 +1115,12 @@ if ( this == that )
Example exception:
-while ( more lines are read )
+while (more lines are read)
{
/* Please document what is/is not a comment line here */
- if ( it's a comment ) continue;
+ if (it's a comment) continue;
- do_something( line );
+ do_something(line);
}
@@ -1141,7 +1137,7 @@ while ( more lines are read )
Example:
-if ( this == that )
+if (this == that)
{
do_something();
do_something_else();
@@ -1149,11 +1145,11 @@ if ( this == that )
Instead of:
- if ( this == that ) do_something(); do_something_else();
+ if (this == that) do_something(); do_something_else();
or
- if ( this == that ) do_something();
+ 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
@@ -1170,11 +1166,11 @@ if ( this == that )
Example:
-structure->flag = ( condition );
+structure->flag = (condition);
Instead of:
- if ( condition ) { structure->flag = 1; } else {
+ if (condition) { structure->flag = 1; } else {
structure->flag = 0; }
Note: The former is readable and concise. The later
@@ -1200,10 +1196,6 @@ int first_value = 0;
int some_value = 0;
int another_value = 0;
int this_variable = 0;
-
-if ( this_variable == this_variable )
-
-first_value = old_value + ( ( some_value - another_value ) - whatever )
@@ -1242,19 +1234,19 @@ function_name();
int function1( ... )
{
...code...
- return( ret_code );
+ return(ret_code);
-} /* -END- function1 */
+} /* -END- function1 */
int function2( ... )
{
-} /* -END- function2 */
+} /* -END- function2 */
Instead of:
- int function1( ... ) { ...code... return( ret_code ); } int
+ int function1( ... ) { ...code... return(ret_code); } int
function2( ... ) { }
Note: Use 1 blank line before the closing brace and 2
@@ -1291,16 +1283,16 @@ static const char * const url_code_map[256] =
int function1( ... )
{
- if ( 1 )
+ if (1)
{
- return( ALWAYS_TRUE );
+ return ALWAYS_TRUE;
}
else
{
- return( HOW_DID_YOU_GET_HERE );
+ return HOW_DID_YOU_GET_HERE;
}
- return( NEVER_GETS_HERE );
+ return NEVER_GETS_HERE;
}
@@ -1385,7 +1377,7 @@ is_web_page_blank();
Example:
-for ( size_t cnt = 0; cnt < block_list_length(); cnt++ )
+for (size_t cnt = 0; cnt < block_list_length(); cnt++)
{
....
}
@@ -1408,7 +1400,7 @@ for ( size_t cnt = 0; cnt < block_list_length(); cnt++ )
size_t len = block_list_length();
-for ( size_t cnt = 0; cnt < len; cnt++ )
+for (size_t cnt = 0; cnt < len; cnt++)
{
....
}
@@ -1428,12 +1420,12 @@ for ( size_t cnt = 0; cnt < len; cnt++ )
This allows a developer to define a const pointer and call
your function. If your function does not have the const
keyword, we may not be able to use your function. Consider
- strcmp, if it were defined as: extern int strcmp( char *s1,
- char *s2 );
+ strcmp, if it were defined as: extern int strcmp(char *s1,
+ char *s2);
- I could then not use it to compare argv's in main: int main(
- int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
- ); }
+ I could then not use it to compare argv's in main: int
+ main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
+ }
Both these pointers are *const*! If the c runtime library
maintainers do it, we should too.
@@ -1448,11 +1440,11 @@ for ( size_t cnt = 0; cnt < len; cnt++ )
Most structures cannot fit onto a normal stack entry (i.e.
they are not 4 bytes or less). Aka, a function declaration
- like: int load_aclfile( struct client_state csp )
+ like: int load_aclfile(struct client_state csp)
would not work. So, to be consistent, we should declare all
- prototypes with "pass by value": int load_aclfile( struct
- client_state *csp )
+ prototypes with "pass by value": int load_aclfile(struct
+ client_state *csp)
@@ -1595,22 +1587,22 @@ extern file_list *xyz;
Example:
-switch( hash_string( cmd ) )
+switch (hash_string(cmd))
{
- case hash_actions_file :
+ case hash_actions_file:
... code ...
break;
- case hash_confdir :
+ case hash_confdir:
... code ...
break;
- default :
+ default:
log_error( ... );
... anomaly code goes here ...
continue; / break; / exit( 1 ); / etc ...
-} /* end switch( hash_string( cmd ) ) */
+} /* end switch (hash_string(cmd)) */
Note: If you already have a default condition, you
are obviously exempt from this point. Of note, most of the
@@ -1650,24 +1642,6 @@ switch( hash_string( cmd ) )
necessary.
-
-
-
- Use 'long' or 'short' Instead of
- 'int'
-
- 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?
-
-
@@ -1753,8 +1727,8 @@ list, then it should definitely be allocated via `malloc'.
Example:
-int load_re_filterfile( struct client_state *csp ) { ... }
-static void unload_re_filterfile( void *f ) { ... }
+int load_re_filterfile(struct client_state *csp) { ... }
+static void unload_re_filterfile(void *f) { ... }
Exceptions:
@@ -1789,7 +1763,7 @@ static void unload_re_filterfile( void *f ) { ... }
"Uncertain" new code and/or changes to
- existing code, use FIXME or XXX
+ existing code, use XXX
Explanation:
@@ -1797,18 +1771,18 @@ static void unload_re_filterfile( void *f ) { ... }
your changes, but are not *quite* sure of the repercussions,
add this:
- /* FIXME: this code has a logic error on platform XYZ, *
+ /* XXX: this code has a logic error on platform XYZ, *
attempting to fix */ #ifdef PLATFORM ...changed code here...
#endif
or:
- /* FIXME: I think the original author really meant this...
+ /* XXX: I think the original author really meant this...
*/ ...changed code here...
or:
- /* FIXME: new code that *may* break something else... */
+ /* XXX: new code that *may* break something else... */
...new code here...
Note: If you make it clear that this may or may not
@@ -1826,10 +1800,10 @@ static void unload_re_filterfile( void *f ) { ... }
Example for file comments:
-const char FILENAME_rcs[] = "$Id$";
+const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
/*********************************************************************
*
- * File : $Source$
+ * File : $S<!-- Break CVS Substitution -->ource$
*
* Purpose : (Fill me in with a good description!)
*
@@ -1880,10 +1854,10 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id$"
+#define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
/*********************************************************************
*
- * File : $Source$
+ * File : $S<!-- Break CVS Substitution -->ource$
*
* Purpose : (Fill me in with a good description!)
*
@@ -1954,10 +1928,10 @@ extern const char FILENAME_h_rcs[];
* Returns : 0 => Ok, everything else is an error.
*
*********************************************************************/
-int FUNCTION_NAME( void *param1, const char *x )
+int FUNCTION_NAME(void *param1, const char *x)
{
...
- return( 0 );
+ return 0;
}
@@ -2005,24 +1979,7 @@ Install the rpm. Any error messages?
-
-
- Test reports
-
-Please submit test reports only with the test form
-at sourceforge. Three simple steps:
-
-
- Select category: the distribution you test on.
- Select group: the version of Privoxy that we are about to release.
- Fill the Summary and Detailed Description with something
- intelligent (keep it short and precise).
-
-
- Do not mail to the mailing list (we cannot keep track on issues there).
-
-
-
+
@@ -2176,7 +2133,7 @@ at sourceforge. Three simple steps:
Finished docs should be then be committed to CVS (for those
without the ability to build these). Some docs may require
rather obscure processing tools. config,
- the man page (and the html version of the man page), and the PDF docs
+ the man page (and the html version of the man page)
fall in this category. REAMDE, the man page, AUTHORS, and config
should all also be committed to CVS for other packagers. The
formal docs should be uploaded to the webserver. See the
@@ -2589,9 +2546,9 @@ at sourceforge. Three simple steps:
Windows
- You should ensure you have the latest version of Cygwin (from
- http://www.cygwin.com/).
- Run the following commands from within a Cygwin bash shell.
+ Use the
+ Cygwin Time Machine to install the last 1.5 version of Cygwin.
+ Run the following commands from within the Cygwin 1.5 bash shell.
First, make sure that you have freshly exported the right
@@ -2754,7 +2711,7 @@ at sourceforge. Three simple steps:
The module contains complete instructions on its usage in its
- README file. The end result will be the the
+ README file. The end result will be the
exported version of Privoxy installed on the build machine.
@@ -2762,114 +2719,10 @@ at sourceforge. Three simple steps:
FreeBSD
- Login to Sourceforge's compile-farm via ssh:
-
-
-
- ssh cf.sourceforge.net
-
-
-
- Choose the right operating system.
- When logged in, make sure that you have freshly exported the right
- version into an empty directory. (See "Building and releasing
- packages" above). Then run:
-
-
-
- cd current
- autoheader && autoconf && ./configure
-
-
-
- Then run:
-
-
-
- gmake freebsd-dist
-
-
-
- which creates a gzip'ed tar archive. Sadly, you cannot use make
- freebsd-upload on the Sourceforge machine (no ncftpput). You now have
- to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
- source tarball package.
-
-
-
- HP-UX 11
-
- First, make sure that you have freshly exported the right
- version into an empty directory. (See "Building and releasing
- packages" above). Then run:
-
-
-
- cd current
- autoheader && autoconf && ./configure
-
-
-
- Then do FIXME.
-
-
-
- Amiga OS
-
- First, make sure that you have freshly exported the right
- version into an empty directory. (See "Building and releasing
- packages" above). Then run:
-
-
-
- cd current
- autoheader && autoconf && ./configure
-
-
-
- Then do FIXME.
-
-
-
- AIX
-
- Login to Sourceforge's compilefarm via ssh:
-
-
-
- ssh cf.sourceforge.net
-
-
-
- Choose the right operating system.
- When logged in, make sure that you have freshly exported the right
- version into an empty directory. (See "Building and releasing
- packages" above). Then run:
-
-
-
- cd current
- autoheader && autoconf && ./configure
-
-
-
- Then run:
-
-
-
- make aix-dist
-
-
-
- which creates a gzip'ed tar archive. Sadly, you cannot use make
- aix-upload on the Sourceforge machine (no ncftpput). You now have
- to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
- source tarball package.
+ Update the www/privoxy port and submit a diff upstream.
+ For details see the FreeBSD Porter's Handbook.
-
Uploading and Releasing Your Package
@@ -2960,14 +2813,13 @@ at sourceforge. Three simple steps:
- make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
+ make dok
That will generate doc/webserver/user-manual,
doc/webserver/developer-manual,
doc/webserver/faq,
- doc/pdf/*.pdf and
doc/webserver/index.html automatically.
@@ -3004,46 +2856,6 @@ at sourceforge. Three simple steps:
-
- Contacting the developers, Bug Reporting and Feature Requests
-
- &contacting;
-
-
-
-
-
-Privoxy Copyright, License and History
-
-
- ©right;
-
-
-
-License
-
- &license;
-
-
-
-
-
-History
-
- &history;
-
-
-
-
-
-
- See also
-
- &seealso;
-
-
-
-