X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fdeveloper-manual.sgml;h=f6b892d064a799c13f0844d6f8f0ecbd8ce1d8b5;hp=70f4d3baea4820bbba0e2e5304943a4a1675455d;hb=c7277a8982dd2acb7a60877c7b903674bcfc3c34;hpb=4ca1b3964ffd8d2ac27cf2a9f4de9bb7ac67259e diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index 70f4d3ba..f6b892d0 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -5,13 +5,10 @@ - - - - - - - + + + + @@ -24,9 +21,9 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: developer-manual.sgml,v 2.37 2011/11/13 17:03:54 fabiankeil Exp $ + $Id: developer-manual.sgml,v 2.66 2016/02/02 13:08:55 fabiankeil Exp $ - Copyright (C) 2001-2009 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.37 2011/11/13 17:03:54 fabiankeil Exp $ + $Id: developer-manual.sgml,v 2.66 2016/02/02 13:08:55 fabiankeil Exp $ @@ -190,6 +189,7 @@ Hal. url="http://ijbswa.cvs.sourceforge.net/ijbswa/">http://ijbswa.cvs.sourceforge.net/ijbswa/, which might help with visualizing how these pieces fit together. + At one time there were two distinct branches: stable and unstable. The more drastic changes were to be in the unstable branch. These branches @@ -227,8 +228,8 @@ Hal. 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. We expect anyone with CVS access to strictly adhere to the following guidelines: @@ -363,14 +364,12 @@ Hal. 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 - doc/webserver/*. And PDF version are kept in - doc/pdf/*. + doc/webserver/*. 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/. @@ -385,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 @@ -585,7 +582,7 @@ Hal. 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: @@ -731,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 @@ -740,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 ... } @@ -774,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(); } @@ -821,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*/ } @@ -838,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(); } @@ -915,7 +912,7 @@ short do_something_very_important( Example: -if ( 1 == X ) +if (1 == X) { do_something_very_important(); ...some long list of commands... @@ -923,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) */ @@ -977,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) @@ -1002,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) @@ -1027,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 @@ -1095,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 @@ -1118,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); } @@ -1140,7 +1137,7 @@ while ( more lines are read ) Example: -if ( this == that ) +if (this == that) { do_something(); do_something_else(); @@ -1148,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 @@ -1169,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 @@ -1199,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 ) @@ -1241,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 @@ -1290,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; } @@ -1384,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++) { .... } @@ -1407,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++) { .... } @@ -1427,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. @@ -1447,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) @@ -1594,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 @@ -1649,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? - - @@ -1752,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: @@ -1788,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: @@ -1796,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 @@ -1825,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!) * @@ -1879,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!) * @@ -1953,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; } @@ -2004,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). - - - + @@ -2040,8 +1998,8 @@ at sourceforge. Three simple steps: - The following programs are required to follow this process: - ncftpput (ncftp), scp, ssh (ssh), + The following programs are required to follow this process: + ncftpput (ncftp), scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs. @@ -2175,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 @@ -2402,51 +2360,51 @@ at sourceforge. Three simple steps: Source Tarball - - First, make sure that you have freshly exported the right + + 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: - - - + + + Then do: + + + make tarball-dist - - - To upload the package to Sourceforge, simply issue - - - + + + To upload the package to Sourceforge, simply issue + + + make tarball-upload - - - Go to the displayed URL and release the file publicly on Sourceforge. + + + Go to the displayed URL and release the file publicly on Sourceforge. For the change log field, use the relevant section of the ChangeLog file. SuSE, Conectiva or Red Hat RPM - + In following text, replace dist with either rh for Red Hat or suse for SuSE. - - - First, make sure that you have freshly exported the right + + + First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). - - + + As the only exception to not changing anything after export from CVS, now examine the file privoxy-dist.spec and make sure that the version information and the RPM release number are @@ -2457,143 +2415,143 @@ at sourceforge. Three simple steps: file list if unsure. Else, it must be set to the highest already available RPM release number for that version plus one. - - + + Then run: - - - + + + cd current autoheader && autoconf && ./configure - - - Then do - - - + + + Then do + + + make dist-dist - - - To upload the package to Sourceforge, simply issue - - - + + + To upload the package to Sourceforge, simply issue + + + make dist-upload rpm_packagerev - - + + where rpm_packagerev is the RPM release number as determined above. - Go to the displayed URL and release the file publicly on Sourceforge. + Go to the displayed URL and release the file publicly on Sourceforge. Use the release notes and change log from the source tarball package. OS/2 - First, make sure that you have freshly exported the right + First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). Then get the OS/2 Setup module: - - - + + + cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup - - - You will need a mix of development tools. - The main compilation takes place with IBM Visual Age C++. - Some ancillary work takes place with GNU tools, available from - various sources like hobbes.nmsu.edu. - Specificially, you will need autoheader, - autoconf and sh tools. - The packaging takes place with WarpIN, available from various sources, including - its home page: xworkplace. - - - Change directory to the os2setup directory. - Edit the os2build.cmd file to set the final executable filename. - For example, - - - + + + You will need a mix of development tools. + The main compilation takes place with IBM Visual Age C++. + Some ancillary work takes place with GNU tools, available from + various sources like hobbes.nmsu.edu. + Specificially, you will need autoheader, + autoconf and sh tools. + The packaging takes place with WarpIN, available from various sources, including + its home page: xworkplace. + + + Change directory to the os2setup directory. + Edit the os2build.cmd file to set the final executable filename. + For example, + + + installExeName='privoxyos2_setup_X.Y.Z.exe' - - - Next, edit the IJB.wis file so the release number matches - in the PACKAGEID section: - - - + + + Next, edit the IJB.wis file so the release number matches + in the PACKAGEID section: + + + PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z" - - - You're now ready to build. Run: - - - + + + You're now ready to build. Run: + + + os2build - - + + You will find the WarpIN-installable executable in the ./files directory. Upload this anonymously to uploads.sourceforge.net/incoming, create a release for it, and you're done. Use the release notes and Change Log from the source tarball package. - + Solaris - Login to Sourceforge's compilefarm via ssh: - - - + Login to Sourceforge's compilefarm via ssh: + + + ssh cf.sourceforge.net - - - Choose the right operating system (not the Debian one). + + + Choose the right operating system (not the Debian one). 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 - - - + + + Then run + + + gmake solaris-dist - - - which creates a gzip'ed tar archive. Sadly, you cannot use make - solaris-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 + + + which creates a gzip'ed tar archive. Sadly, you cannot use make + solaris-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. - + 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 + First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). Then get the Windows setup module: @@ -2646,7 +2604,7 @@ at sourceforge. Three simple steps: This will create ../privoxy_&p-version;-&p-status;-1_i386.deb which can be uploaded. To upload the package to Sourceforge, simply - issue + issue @@ -2657,159 +2615,114 @@ at sourceforge. Three simple steps: Mac OS X - First, make sure that you have freshly exported the right + First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing - packages" above). Then get the Mac OS X setup module: - - - + packages" above). + + + There are three modules available in the CVS repository for use on Mac + OS X, though technically only two of them generate a release (the other + can be used to install from source). + + + OSXPackageBuilder module + + The OSXPackageBuilder module generates OS X installer packages + supporting all Macs running OS X 10.4 and above. Obtain it from CVS as + follows into a folder parallel to the exported privoxy source: + + cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder + + + + The module contains complete instructions on its usage in the file + OS X Package Builder HOWTO.txt. + + + Once the package(s) have been generated, you can then upload them + directly to the Files section of the Sourceforge project in the + Macintosh (OS X) folder. Each new version release of Privoxy should + have a new subfolder created in which to store its files. Please + ensure that the folder contains a readme file that makes it clear + which package is for whichversion of OS X. + + + + osxsetup module (DEPRECATED) + + This module is deprecated since the installer it generates + places all Privoxy files in one folder in a non-standard location, and + supports only Intel Macs running OS X 10.6 or higher. + + + Check out the module from CVS as follows into a folder parallel to the + exported privoxy source: + cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup - - - Then run: - - - + + + Then run: + + + cd osxsetup build - - - This will run autoheader, autoconf and - configure as well as make. - Finally, it will copy over the necessary files to the ./osxsetup/files directory - for further processing by PackageMaker. - - - Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package - name to match the release, and hit the "Create package" button. - If you specify ./Privoxy.pkg as the output package name, you can then create - the distributable zip file with the command: - - - + + + This will run autoheader, autoconf + and configure as well as make. + Finally, it will copy over the necessary files to the ./osxsetup/files + directory for further processing by PackageMaker. + + + Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, + modify the package name to match the release, and hit the "Create + package" button. If you specify ./Privoxy.pkg as the output package + name, you can then create the distributable zip file with the command: + + + zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg - - - You can then upload privoxyosx_setup_x.y.z.zip anonymously to - uploads.sourceforge.net/incoming, - create a release for it, and you're done. Use the release notes - and Change Log from the source tarball package. - - - - 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 + + + You can then upload this file directly to the Files section of the + Sourceforge project in the Macintosh (OS X) folder. Each new version + release of Privoxy should have a new subfolder created in which to + store its files. + Please ensure that the folder contains a readme file that makes it + clear which version(s) of OS X the package supports. + + + + macsetup module + + The macsetup module is ideal if you wish to build and install Privoxy + from source on a single machine. + + + Check out the module from CVS as follows into a folder parallel to the + exported privoxy source: + + cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup - - - Then do FIXME. - + + + The module contains complete instructions on its usage in its + README file. The end result will be the + exported version of Privoxy installed on the build machine. + + - AIX + FreeBSD - 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 @@ -2900,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. @@ -2944,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; - - - -