This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 2.40 2012/03/18 15:41:49 fabiankeil Exp $
+ $Id: developer-manual.sgml,v 2.46 2012/03/20 13:04:54 fabiankeil Exp $
- Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2012 Privoxy Developers http://www.privoxy.org/
See LICENSE.
========================================================================
</pubdate>
- <pubdate>$Id: developer-manual.sgml,v 2.40 2012/03/18 15:41:49 fabiankeil Exp $</pubdate>
+ <pubdate>$Id: developer-manual.sgml,v 2.46 2012/03/20 13:04:54 fabiankeil Exp $</pubdate>
<!--
url="http://ijbswa.cvs.sourceforge.net/ijbswa/">http://ijbswa.cvs.sourceforge.net/ijbswa/</ulink>,
which might help with visualizing how these pieces fit together.
</para>
+ <!--
<para>
Branches are used to fork a sub-development path from the main trunk.
Within the <literal>current</literal> module where the sources are, there
linkend="versionnumbers">Version Numbers</link> below for details on
versioning.)
</para>
+ -->
<para>
At one time there were two distinct branches: stable and unstable. The
more drastic changes were to be in the unstable branch. These branches
<para>
The source tree is the heart of every software project. Every effort must
be made to ensure that it is readable, compilable and consistent at all
- times. There are differing guidelines for the stable branch and the
- main development trunk, and we ask anyone with CVS access to strictly
+ times. <!-- There are differing guidelines for the stable branch and the
+ main development trunk, and --> We expect anyone with CVS access to strictly
adhere to the following guidelines:
</para>
Packagers are encouraged to include this documentation. For those without
the ability to build the docs locally, text versions of each are kept in
CVS. HTML versions are also being kept in CVS under
- <filename>doc/webserver/*</filename>. And PDF version are kept in
- <filename>doc/pdf/*</filename>.
+ <filename>doc/webserver/*</filename>.
</para>
<para>
Formal documents are built with the Makefile targets of
- <computeroutput>make dok</computeroutput>, or alternately
- <computeroutput>make redhat-dok</computeroutput>. If you have problems,
- try both. The build process uses the document SGML sources in
+ <computeroutput>make dok</computeroutput>.
+ The build process uses the document SGML sources in
<computeroutput>doc/source/*/*</computeroutput> to update all text files in
<computeroutput>doc/text/</computeroutput> and to update all HTML
documents in <computeroutput>doc/webserver/</computeroutput>.
<orderedlist numeration="arabic">
<listitem><para>
First, build the docs by running <computeroutput>make
- dok</computeroutput> (or alternately <computeroutput>make
- redhat-dok</computeroutput>). For PDF docs, do <computeroutput>make
- dok-pdf</computeroutput>.
+ dok</computeroutput>.
</para></listitem>
<listitem><para>
Run <computeroutput>make webserver</computeroutput> which copies all
<listitem>
<para>
Our documents are available in differing formats. Right now, they
- are just plain text, HTML, and PDF, but others are always a
+ are just plain text and/or HTML, but others are always a
future possibility. Be careful with URLs (<ulink>), and avoid
this mistake:
</para>
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!</para>
+ help your fellow Privoxy developers out!</para>
<para>The comments will also help justify the intent of the code.
If the comment describes something different than what the code
<para><emphasis>Example:</emphasis></para>
<programlisting>
/* 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 ...
}
/*********************************************************************
* 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();
}</programlisting>
* 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*/
}
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();
}
<para><emphasis>Example:</emphasis></para>
<programlisting>
-if ( 1 == X )
+if (1 == X)
{
do_something_very_important();
...some long list of commands...
or:
-if ( 1 == X )
+if (1 == X)
{
do_something_very_important();
...some long list of commands...
-} /* -END- if ( 1 == X ) */
+} /* -END- if (1 == X) */
</programlisting>
</sect3>
<para><emphasis>Example:</emphasis></para>
<programlisting>
-int load_some_file( struct client_state *csp )</programlisting>
+int load_some_file(struct client_state *csp)</programlisting>
<para><emphasis>Instead of:</emphasis></para>
<para>
<programlisting>
-int loadsomefile( struct client_state *csp )
-int loadSomeFile( struct client_state *csp )
+int loadsomefile(struct client_state *csp)
+int loadSomeFile(struct client_state *csp)
</programlisting>
</para>
<para><emphasis>Example:</emphasis></para>
<programlisting>
-(.h) extern int load_aclfile( struct client_state *csp );
-(.c) int load_aclfile( struct client_state *csp )</programlisting>
+(.h) extern int load_aclfile(struct client_state *csp);
+(.c) int load_aclfile(struct client_state *csp)</programlisting>
<para><emphasis>Instead of:</emphasis>
<programlisting>
-(.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)
</programlisting>
</para>
<para><emphasis>Example:</emphasis></para>
<programlisting>
-(enumeration) : enum Boolean { FALSE, TRUE };
+(enumeration) : enum Boolean {FALSE, TRUE};
(#define) : #define DEFAULT_SIZE 100;</programlisting>
<para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
<para><emphasis>Example:</emphasis></para>
<programlisting>
-if ( this == that )
+if (this == that)
{
...
}</programlisting>
<para><emphasis>Instead of:</emphasis></para>
- <para>if ( this == that ) { ... }</para>
+ <para>if (this == that) { ... }</para>
<para>or</para>
- <para>if ( this == that ) { ... }</para>
+ <para>if (this == that) { ... }</para>
<para><emphasis>Note:</emphasis> In the special case that the if-statement is
inside a loop, and it is trivial, i.e. it tests for a
<para><emphasis>Example exception:</emphasis></para>
<programlisting>
-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);
}
</programlisting>
</sect3>
<para><emphasis>Example:</emphasis></para>
<programlisting>
-if ( this == that )
+if (this == that)
{
do_something();
do_something_else();
<para><emphasis>Instead of:</emphasis></para>
- <para>if ( this == that ) do_something(); do_something_else();</para>
+ <para>if (this == that) do_something(); do_something_else();</para>
<para>or</para>
- <para>if ( this == that ) do_something();</para>
+ <para>if (this == that) do_something();</para>
<para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
in a manner other than that which the developer desired (per
<para><emphasis>Example:</emphasis></para>
<programlisting>
-structure->flag = ( condition );</programlisting>
+structure->flag = (condition);</programlisting>
<para><emphasis>Instead of:</emphasis></para>
- <para>if ( condition ) { structure->flag = 1; } else {
+ <para>if (condition) { structure->flag = 1; } else {
structure->flag = 0; }</para>
<para><emphasis>Note:</emphasis> The former is readable and concise. The later
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 )
</programlisting>
</sect3>
int function1( ... )
{
...code...
- return( ret_code );
+ return(ret_code);
-} /* -END- function1 */
+} /* -END- function1 */
int function2( ... )
{
-} /* -END- function2 */
+} /* -END- function2 */
</programlisting>
<para><emphasis>Instead of:</emphasis></para>
- <para>int function1( ... ) { ...code... return( ret_code ); } int
+ <para>int function1( ... ) { ...code... return(ret_code); } int
function2( ... ) { }</para>
<para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
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;
}
</programlisting>
<para><emphasis>Example:</emphasis></para>
<programlisting>
-for ( size_t cnt = 0; cnt < block_list_length(); cnt++ )
+for (size_t cnt = 0; cnt < block_list_length(); cnt++)
{
....
}</programlisting>
<programlisting>
size_t len = block_list_length();
-for ( size_t cnt = 0; cnt < len; cnt++ )
+for (size_t cnt = 0; cnt < len; cnt++)
{
....
}</programlisting>
<para>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 );</para>
+ strcmp, if it were defined as: extern int strcmp(char *s1,
+ char *s2);</para>
- <para>I could then not use it to compare argv's in main: int main(
- int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
- ); }</para>
+ <para>I could then not use it to compare argv's in main: int
+ main(int argc, const char *argv[]) { strcmp(argv[0], "privoxy");
+ }</para>
<para>Both these pointers are *const*! If the c runtime library
maintainers do it, we should too.</para>
<para>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 )</para>
+ like: int load_aclfile(struct client_state csp)</para>
<para>would not work. So, to be consistent, we should declare all
- prototypes with "pass by value": int load_aclfile( struct
- client_state *csp )</para>
+ prototypes with "pass by value": int load_aclfile(struct
+ client_state *csp)</para>
</sect3>
<para><emphasis>Example:</emphasis></para>
<programlisting>
-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 ) ) */</programlisting>
+} /* end switch (hash_string(cmd)) */</programlisting>
<para><emphasis>Note:</emphasis> If you already have a default condition, you
are obviously exempt from this point. Of note, most of the
<para><emphasis>Example:</emphasis></para>
<programlisting>
-int load_re_filterfile( struct client_state *csp ) { ... }
-static void unload_re_filterfile( void *f ) { ... }</programlisting>
+int load_re_filterfile(struct client_state *csp) { ... }
+static void unload_re_filterfile(void *f) { ... }</programlisting>
<para><emphasis>Exceptions:</emphasis></para>
* 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;
}
</programlisting>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: developer-manual.sgml,v $
+ Revision 2.46 2012/03/20 13:04:54 fabiankeil
+ IJB is dead, long live Privoxy
+
+ Revision 2.45 2012/03/20 13:04:41 fabiankeil
+ The redhat-dok target no longer exists so there's no point documenting it
+
+ Revision 2.44 2012/03/20 13:04:19 fabiankeil
+ We no longer build PDFs so stop pretending
+
+ Revision 2.43 2012/03/20 13:04:03 fabiankeil
+ Comment out references to multiple branches
+
+ We currently don't use any.
+
+ Revision 2.42 2012/03/20 13:03:05 fabiankeil
+ Bump copyright date
+
+ Revision 2.41 2012/03/19 12:56:08 fabiankeil
+ Untabify
+
Revision 2.40 2012/03/18 15:41:49 fabiankeil
Bump entities to 3.0.20 UNRELEASED
projects / privoxy.git / blobdiff