Menu
▾
▴
[privoxy-commits] current/doc/source developer-manual.sgml, 2.46, 2.47
|
From: Fabian K. <fab...@us...> - 2012-03-20 13:05:17
|
Update of /cvsroot/ijbswa/current/doc/source
In directory vz-cvs-4.sog:/tmp/cvs-serv32754/doc/source
Modified Files:
developer-manual.sgml
Log Message:
Adjust whitespace in examples to be closer to our style
Index: developer-manual.sgml
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v
retrieving revision 2.46
retrieving revision 2.47
diff -C2 -d -r2.46 -r2.47
*** developer-manual.sgml 20 Mar 2012 13:04:54 -0000 2.46
--- developer-manual.sgml 20 Mar 2012 13:05:14 -0000 2.47
***************
*** 739,743 ****
<programlisting>
/* if page size greater than 1k ... */
! if ( page_length() > 1024 )
{
... "block" the page up ...
--- 739,743 ----
<programlisting>
/* if page size greater than 1k ... */
! if (page_length() > 1024)
{
... "block" the page up ...
***************
*** 745,749 ****
/* if page size is small, send it in blocks */
! if ( page_length() > 1024 )
{
... "block" the page up ...
--- 745,749 ----
/* if page size is small, send it in blocks */
! if (page_length() > 1024)
{
... "block" the page up ...
***************
*** 773,777 ****
* This will stand out clearly in your code!
*********************************************************************/
! if ( this_variable == that_variable )
{
do_something_very_important();
--- 773,777 ----
* This will stand out clearly in your code!
*********************************************************************/
! if (this_variable == that_variable)
{
do_something_very_important();
***************
*** 780,784 ****
/* unfortunately, this may not */
! if ( this_variable == that_variable )
{
do_something_very_important();
--- 780,784 ----
/* unfortunately, this may not */
! if (this_variable == that_variable)
{
do_something_very_important();
***************
*** 786,790 ****
! if ( this_variable == that_variable ) /* this may not either */
{
do_something_very_important();
--- 786,790 ----
! if (this_variable == that_variable) /* this may not either */
{
do_something_very_important();
***************
*** 820,829 ****
* But the second example won't.
*********************************************************************/
! if ( this_variable == this_variable )
{
do_something_very_important();
}
! if ( this_variable == this_variable ) /*can you see me?*/
{
do_something_very_important(); /*not easily*/
--- 820,829 ----
* But the second example won't.
*********************************************************************/
! if (this_variable == this_variable)
{
do_something_very_important();
}
! if (this_variable == this_variable) /*can you see me?*/
{
do_something_very_important(); /*not easily*/
***************
*** 837,841 ****
int urls_rejected = 0; /* # of urls rejected */
! if ( 1 == X )
{
do_something_very_important();
--- 837,841 ----
int urls_rejected = 0; /* # of urls rejected */
! if (1 == X)
{
do_something_very_important();
***************
*** 914,918 ****
<para><emphasis>Example:</emphasis></para>
<programlisting>
! if ( 1 == X )
{
do_something_very_important();
--- 914,918 ----
<para><emphasis>Example:</emphasis></para>
<programlisting>
! if (1 == X)
{
do_something_very_important();
***************
*** 922,930 ****
or:
! if ( 1 == X )
{
do_something_very_important();
...some long list of commands...
! } /* -END- if ( 1 == X ) */
</programlisting>
</sect3>
--- 922,930 ----
or:
! if (1 == X)
{
do_something_very_important();
...some long list of commands...
! } /* -END- if (1 == X) */
</programlisting>
</sect3>
***************
*** 976,980 ****
<para><emphasis>Example:</emphasis></para>
<programlisting>
! int load_some_file( struct client_state *csp )</programlisting>
<para><emphasis>Instead of:</emphasis></para>
--- 976,980 ----
<para><emphasis>Example:</emphasis></para>
<programlisting>
! int load_some_file(struct client_state *csp)</programlisting>
<para><emphasis>Instead of:</emphasis></para>
***************
*** 982,987 ****
<para>
<programlisting>
! int loadsomefile( struct client_state *csp )
! int loadSomeFile( struct client_state *csp )
</programlisting>
</para>
--- 982,987 ----
<para>
<programlisting>
! int loadsomefile(struct client_state *csp)
! int loadSomeFile(struct client_state *csp)
</programlisting>
</para>
***************
*** 1001,1012 ****
<para><emphasis>Example:</emphasis></para>
<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();
! (.c) int load_aclfile( struct client_state *csp )
</programlisting>
</para>
--- 1001,1012 ----
<para><emphasis>Example:</emphasis></para>
<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();
! (.c) int load_aclfile(struct client_state *csp)
</programlisting>
</para>
***************
*** 1026,1030 ****
<para><emphasis>Example:</emphasis></para>
<programlisting>
! (enumeration) : enum Boolean { FALSE, TRUE };
(#define) : #define DEFAULT_SIZE 100;</programlisting>
--- 1026,1030 ----
<para><emphasis>Example:</emphasis></para>
<programlisting>
! (enumeration) : enum Boolean {FALSE, TRUE};
(#define) : #define DEFAULT_SIZE 100;</programlisting>
***************
*** 1094,1098 ****
<para><emphasis>Example:</emphasis></para>
<programlisting>
! if ( this == that )
{
...
--- 1094,1098 ----
<para><emphasis>Example:</emphasis></para>
<programlisting>
! if (this == that)
{
...
***************
*** 1101,1109 ****
<para><emphasis>Instead of:</emphasis></para>
! <para>if ( this == that ) { ... }</para>
<para>or</para>
! <para>if ( this == that ) { ... }</para>
<para><emphasis>Note:</emphasis> In the special case that the if-statement is
--- 1101,1109 ----
<para><emphasis>Instead of:</emphasis></para>
! <para>if (this == that) { ... }</para>
<para>or</para>
! <para>if (this == that) { ... }</para>
<para><emphasis>Note:</emphasis> In the special case that the if-statement is
***************
*** 1117,1126 ****
<para><emphasis>Example exception:</emphasis></para>
<programlisting>
! while ( more lines are read )
{
/* Please document what is/is not a comment line here */
! if ( it's a comment ) continue;
! do_something( line );
}
</programlisting>
--- 1117,1126 ----
<para><emphasis>Example exception:</emphasis></para>
<programlisting>
! while (more lines are read)
{
/* Please document what is/is not a comment line here */
! if (it's a comment) continue;
! do_something(line);
}
</programlisting>
***************
*** 1139,1143 ****
<para><emphasis>Example:</emphasis></para>
<programlisting>
! if ( this == that )
{
do_something();
--- 1139,1143 ----
<para><emphasis>Example:</emphasis></para>
<programlisting>
! if (this == that)
{
do_something();
***************
*** 1147,1155 ****
<para><emphasis>Instead of:</emphasis></para>
! <para>if ( this == that ) do_something(); do_something_else();</para>
<para>or</para>
! <para>if ( this == that ) do_something();</para>
<para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
--- 1147,1155 ----
<para><emphasis>Instead of:</emphasis></para>
! <para>if (this == that) do_something(); do_something_else();</para>
<para>or</para>
! <para>if (this == that) do_something();</para>
<para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
***************
*** 1168,1176 ****
<para><emphasis>Example:</emphasis></para>
<programlisting>
! structure->flag = ( condition );</programlisting>
<para><emphasis>Instead of:</emphasis></para>
! <para>if ( condition ) { structure->flag = 1; } else {
structure->flag = 0; }</para>
--- 1168,1176 ----
<para><emphasis>Example:</emphasis></para>
<programlisting>
! structure->flag = (condition);</programlisting>
<para><emphasis>Instead of:</emphasis></para>
! <para>if (condition) { structure->flag = 1; } else {
structure->flag = 0; }</para>
***************
*** 1198,1205 ****
int another_value = 0;
int this_variable = 0;
-
- if ( this_variable == this_variable )
-
- first_value = old_value + ( ( some_value - another_value ) - whatever )
</programlisting>
</sect3>
--- 1198,1201 ----
***************
*** 1240,1256 ****
{
...code...
! return( ret_code );
! } /* -END- function1 */
int function2( ... )
{
! } /* -END- function2 */
</programlisting>
<para><emphasis>Instead of:</emphasis></para>
! <para>int function1( ... ) { ...code... return( ret_code ); } int
function2( ... ) { }</para>
--- 1236,1252 ----
{
...code...
! return(ret_code);
! } /* -END- function1 */
int function2( ... )
{
! } /* -END- function2 */
</programlisting>
<para><emphasis>Instead of:</emphasis></para>
! <para>int function1( ... ) { ...code... return(ret_code); } int
function2( ... ) { }</para>
***************
*** 1289,1302 ****
int function1( ... )
{
! if ( 1 )
{
! return( ALWAYS_TRUE );
}
else
{
! return( HOW_DID_YOU_GET_HERE );
}
! return( NEVER_GETS_HERE );
}
--- 1285,1298 ----
int function1( ... )
{
! if (1)
{
! return ALWAYS_TRUE;
}
else
{
! return HOW_DID_YOU_GET_HERE;
}
! return NEVER_GETS_HERE;
}
***************
*** 1383,1387 ****
<para><emphasis>Example:</emphasis></para>
<programlisting>
! for ( size_t cnt = 0; cnt < block_list_length(); cnt++ )
{
....
--- 1379,1383 ----
<para><emphasis>Example:</emphasis></para>
<programlisting>
! for (size_t cnt = 0; cnt < block_list_length(); cnt++)
{
....
***************
*** 1406,1410 ****
size_t len = block_list_length();
! for ( size_t cnt = 0; cnt < len; cnt++ )
{
....
--- 1402,1406 ----
size_t len = block_list_length();
! for (size_t cnt = 0; cnt < len; cnt++)
{
....
***************
*** 1426,1435 ****
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>
! <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
--- 1422,1431 ----
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>
! <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
***************
*** 1446,1454 ****
<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>
<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>
--- 1442,1450 ----
<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>
<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>
***************
*** 1593,1612 ****
<para><emphasis>Example:</emphasis></para>
<programlisting>
! switch( hash_string( cmd ) )
{
! case hash_actions_file :
... code ...
break;
! case hash_confdir :
... code ...
break;
! default :
log_error( ... );
... anomaly code goes here ...
continue; / break; / exit( 1 ); / etc ...
! } /* end switch( hash_string( cmd ) ) */</programlisting>
<para><emphasis>Note:</emphasis> If you already have a default condition, you
--- 1589,1608 ----
<para><emphasis>Example:</emphasis></para>
<programlisting>
! switch (hash_string(cmd))
{
! case hash_actions_file:
... code ...
break;
! case hash_confdir:
... code ...
break;
! default:
log_error( ... );
... anomaly code goes here ...
continue; / break; / exit( 1 ); / etc ...
! } /* end switch (hash_string(cmd)) */</programlisting>
<para><emphasis>Note:</emphasis> If you already have a default condition, you
***************
*** 1751,1756 ****
<para><emphasis>Example:</emphasis></para>
<programlisting>
! int load_re_filterfile( struct client_state *csp ) { ... }
! static void unload_re_filterfile( void *f ) { ... }</programlisting>
<para><emphasis>Exceptions:</emphasis></para>
--- 1747,1752 ----
<para><emphasis>Example:</emphasis></para>
<programlisting>
! int load_re_filterfile(struct client_state *csp) { ... }
! static void unload_re_filterfile(void *f) { ... }</programlisting>
<para><emphasis>Exceptions:</emphasis></para>
***************
*** 1952,1959 ****
*
*********************************************************************/
! int FUNCTION_NAME( void *param1, const char *x )
{
...
! return( 0 );
}
--- 1948,1955 ----
*
*********************************************************************/
! int FUNCTION_NAME(void *param1, const char *x)
{
...
! return 0;
}
***************
*** 3063,3066 ****
--- 3059,3065 ----
$Log$
+ Revision 2.47 2012/03/20 13:05:14 fabiankeil
+ Adjust whitespace in examples to be closer to our style
+
Revision 2.46 2012/03/20 13:04:54 fabiankeil
IJB is dead, long live Privoxy
|