X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fdeveloper-manual.sgml;h=b55305dc05e89e919cfb726d0395c084706537f1;hp=0920b7646c608894f26d675f3006a30cc8ea5c1f;hb=b93f35c60fa190ec3ae30879632be6269c4de2b3;hpb=de371cd95abbab8891e7ec3b1981ea9a470da6db diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index 0920b764..b55305dc 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -1,5 +1,5 @@ + @@ -7,12 +7,15 @@ - + + + + ]> + + Copyright &my-copy; 2001-2009 by + Privoxy Developers + + + - $Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $ + $Id: developer-manual.sgml,v 2.28 2009/05/16 13:27:21 fabiankeil Exp $ + + + @@ -65,10 +82,12 @@ ]]> - The developer manual gives the users information on how to help the developer - team. It provides guidance on coding, testing, documentation and other - issues. - + The developer manual provides guidance on coding, testing, packaging, documentation + and other issues of importance to those involved with + Privoxy development. It is mandatory (and helpful!) reading + for anyone who wants to join the team. Note that it's currently out of date + and may not be entirely correct. As always, patches are welcome. + @@ -78,12 +97,13 @@ + Please note that this document is constantly evolving. This copy represents + the state at the release of version &p-version;. You can find the latest version of the this manual at http://www.privoxy.org/developer-manual/. - Please see the Contact section + Please see the Contact section on how to contact the developers. - @@ -91,18 +111,9 @@ - - - - - - - - - - Introduction + Introduction Privoxy, as an heir to - Junkbuster, is an Open Source project - and licensed under the GPL. As such, Privoxy - development is potentially open to anyone who has the time, knowledge, - and desire to contribute in any capacity. Our goals are simply to - continue the mission, to improve Privoxy, and + Junkbuster, is a Free Software project + and the code is licensed under the GNU General Public License version 2. + As such, Privoxy development is potentially open + to anyone who has the time, knowledge, and desire to contribute + in any capacity. Our goals are simply to continue the mission, + to improve Privoxy, and to make it available to as wide an audience as possible. One does not have to be a programmer to contribute. Packaging, testing, - and porting, are all important jobs as well. + documenting and porting, are all important jobs as well. - - Quickstart to Privoxy Development + Quickstart to Privoxy Development + + The first step is to join the developer's mailing list. + You can submit your ideas, or even better patches. Patches are best + submitted to the Sourceforge tracker set up for this purpose, but + can be sent to the list for review too. + - You'll need an account on Sourceforge to support our - development. Mail your ID to the list and wait until a - project manager has added you. + You will also need to have a cvs package installed, which will + entail having ssh installed as well (which seems to be a requirement of + SourceForge), in order to access the cvs repository. Having the GNU build + tools is also going to be important (particularly, autoconf and gmake). - For the time being (read, this section is under construction), please - refer to the extensive comments in the source code. + For the time being (read, this section is under construction), you can + also refer to the extensive comments in the source code. In fact, + reading the code is recommended in any case. + The CVS Repository - If you intend to help us with programming, documentation or packaging - you will need write access to our holy grail, the CVS repository. - Please read this chapter completely before accessing via CVS. + If you become part of the active development team, you will eventually + need write access to our holy grail, the CVS repository. One of the + team members will need to set this up for you. Please read + this chapter completely before accessing via CVS. Access to CVS @@ -154,22 +174,72 @@ SF's site documentation for the technical access details for your operating system. For historical reasons, the CVS server is - called cvs.ijbswa.sourceforge.net, the repository is + called ijbswa.cvs.sourceforge.net, the repository is called ijbswa, and the source tree module is called current. - CVS Commit Guideline + + Branches + + Within the CVS repository, there are modules and branches. As + mentioned, the sources are in the current + module. Other modules are present for platform specific + issues. There is a webview of the CVS hierarchy at http://ijbswa.cvs.sourceforge.net/ijbswa/, + which might help with visualizing how these pieces fit together. + + + Branches are used to fork a sub-development path from the main trunk. + Within the current module where the sources are, there + is always at least one branch from the main trunk + devoted to a stable release series. The main trunk is where active + development takes place for the next stable series (e.g. 3.2.x). + So just prior to each stable series (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 Version Numbers below for details on + versioning.) + + + At one time there were two distinct branches: stable and unstable. The + more drastic changes were to be in the unstable branch. These branches + have now been merged to minimize time and effort of maintaining two + branches. + + + + + CVS Commit Guidelines 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. We therefore ask anyone with CVS access to strictly adhere to the - following guidelines: + times. There are differing guidelines for the stable branch and the + main development trunk, and we ask anyone with CVS access to strictly + adhere to the following guidelines: + + + + Basic Guidelines, for all branches: + + - Never (read: never, ever) be tempted to commit - that small change without testing it thoroughly first. When we're + Please don't commit even + a small change without testing it thoroughly first. When we're close to a public release, ask a fellow developer to review your changes. @@ -184,48 +254,69 @@ If your changes span multiple files, and the code won't recompile unless - all changes are commited (e.g. when changing the signature of a function), - then commit all files one after another, without long delays in beween. + all changes are committed (e.g. when changing the signature of a function), + then commit all files one after another, without long delays in between. If necessary, prepare the commit messages in advance. Before changing things on CVS, make sure that your changes are in line - with the team's general consensus on what should be done (see below). + with the team's general consensus on what should be done. + + + Note that near a major public release, we get more cautious. + There is always the possibility to submit a patch to the patch + tracker instead. + + - - - Discussing Changes First + + + @@ -241,25 +332,39 @@ url="../user-manual/index.html">user-manual, FAQ, and, of course this, the developer-manual in this format. - The README, AUTHORS - privoxy.1 (man page) files are also now maintained - as Docbook SGML. The finished files are all in the top-level source - directory are generated files! Also, index.html, the - Privoxy home page, is maintained as SGML. + The README, AUTHORS, + INSTALL, + privoxy.1 (man page), and + config files are also now maintained as Docbook + SGML. These files, when built, in the top-level source directory are + generated files! Also, the Privoxy 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 (at present Stefan and - Hal). + contact someone involved in the documentation. - Other, less formal documents (e.g. LICENSE, - INSTALL) are maintained as plain text files in the - top-level source directory. At least for the time being. + config requires some special handling. The reason it + is maintained this way is so that the extensive comments in the file + mirror those in user-manual. But the conversion + process requires going from SGML to HTML to text to special formatting + required for the embedded comments. Some of this does not survive so + well. Especially some of the examples that are longer than 80 characters. + The build process for this file outputs to config.new, + which should be reviewed for errors and mis-formatting. Once satisfied + that it is correct, then it should be hand copied to + config. + + + Other, less formal documents (e.g. LICENSE) are + maintained as plain text files in the top-level source directory. 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 now being kept in CVS under - doc/webserver/*. + CVS. HTML versions are also being kept in CVS under + doc/webserver/*. And PDF version are kept in + doc/pdf/*. Formal documents are built with the Makefile targets of @@ -281,7 +386,8 @@ First, build the docs by running make dok (or alternately make - redhat-dok). + redhat-dok). For PDF docs, do make + dok-pdf. Run make webserver which copies all @@ -389,6 +495,11 @@ Look at any of the existing docs for examples of all these and more. + + You might also find Writing Documentation + Using DocBook - A Crash Course useful. + @@ -474,7 +585,7 @@ Our documents are available in differing formats. Right now, they - are just plain text, and HTML, but PDF, and others is always a + are just plain text, HTML, and PDF, but others are always a future possibility. Be careful with URLs (<ulink>), and avoid this mistake: @@ -614,8 +725,8 @@ Explanation: Comment as much as possible without commenting the obvious. - For example do not comment "aVariable is equal to bVariable". - Instead explain why aVariable should be equal to the bVariable. + For example do not comment "variable_a is equal to variable_b". + Instead explain why variable_a should be equal to the variable_b. Just because a person can read code does not mean they will 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 @@ -629,13 +740,13 @@ Example: /* if page size greater than 1k ... */ -if ( PageLength() > 1024 ) +if ( page_length() > 1024 ) { ... "block" the page up ... } /* if page size is small, send it in blocks */ -if ( PageLength() > 1024 ) +if ( page_length() > 1024 ) { ... "block" the page up ... } @@ -663,22 +774,22 @@ is actually being done. /********************************************************************* * This will stand out clearly in your code! *********************************************************************/ -if ( thisVariable == thatVariable ) +if ( this_variable == that_variable ) { - DoSomethingVeryImportant(); + do_something_very_important(); } /* unfortunately, this may not */ -if ( thisVariable == thatVariable ) +if ( this_variable == that_variable ) { - DoSomethingVeryImportant(); + do_something_very_important(); } -if ( thisVariable == thatVariable ) /* this may not either */ +if ( this_variable == that_variable ) /* this may not either */ { - DoSomethingVeryImportant(); + do_something_very_important(); } Exception: @@ -710,14 +821,14 @@ if ( thisVariable == thatVariable ) /* this may not either */ * This will stand out clearly in your code, * But the second example won't. *********************************************************************/ -if ( thisVariable == thatVariable ) +if ( this_variable == this_variable ) { - DoSomethingVeryImportant(); + do_something_very_important(); } -if ( thisVariable == thatVariable ) /*can you see me?*/ +if ( this_variable == this_variable ) /*can you see me?*/ { - DoSomethingVeryImportant(); /*not easily*/ + do_something_very_important(); /*not easily*/ } @@ -729,17 +840,17 @@ int urls_rejected = 0; /* # of urls rejected */ if ( 1 == X ) { - DoSomethingVeryImportant(); + do_something_very_important(); } -short DoSomethingVeryImportant( +short do_something_very_important( short firstparam, /* represents something */ short nextparam /* represents something else */ ) { ...code here... -} /* -END- DoSomethingVeryImportant */ +} /* -END- do_something_very_important */ @@ -806,7 +917,7 @@ short DoSomethingVeryImportant( if ( 1 == X ) { - DoSomethingVeryImportant(); + do_something_very_important(); ...some long list of commands... } /* -END- if x is 1 */ @@ -814,7 +925,7 @@ or: if ( 1 == X ) { - DoSomethingVeryImportant(); + do_something_very_important(); ...some long list of commands... } /* -END- if ( 1 == X ) */ @@ -1031,17 +1142,17 @@ while ( more lines are read ) if ( this == that ) { - DoSomething(); - DoSomethingElse(); + do_something(); + do_something_else(); } Instead of: - if ( this == that ) DoSomething(); DoSomethingElse(); + if ( this == that ) do_something(); do_something_else(); or - if ( this == that ) DoSomething(); + 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 @@ -1084,14 +1195,14 @@ structure->flag = ( condition ); Example: -int firstValue = 0; -int someValue = 0; -int anotherValue = 0; -int thisVariable = 0; +int first_value = 0; +int some_value = 0; +int another_value = 0; +int this_variable = 0; -if ( thisVariable == thatVariable ) +if ( this_variable == this_variable ) -firstValue = oldValue + ( ( someValue - anotherValue ) - whatever ) +first_value = old_value + ( ( some_value - another_value ) - whatever ) @@ -1111,12 +1222,12 @@ firstValue = oldValue + ( ( someValue - anotherValue ) - whatever ) Example: -aStruct->aMember; -aStruct.aMember; -FunctionName(); +a_struct->a_member; +a_struct.a_member; +function_name(); - Instead of: aStruct -> aMember; aStruct . aMember; - FunctionName (); + Instead of: a_struct -> a_member; a_struct . a_member; + function_name (); @@ -1130,7 +1241,7 @@ FunctionName(); int function1( ... ) { ...code... - return( retCode ); + return( ret_code ); } /* -END- function1 */ @@ -1142,7 +1253,7 @@ int function2( ... ) Instead of: - int function1( ... ) { ...code... return( retCode ); } int + int function1( ... ) { ...code... return( ret_code ); } int function2( ... ) { } Note: Use 1 blank line before the closing brace and 2 @@ -1212,14 +1323,14 @@ int function1( ... ) Example: -short anShort = 0; -float aFloat = 0; +short a_short = 0; +float a_float = 0; 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 arrayPtr[20] causes a SIGSEV vs. - arrayPtr[0]. + and not 129FA012; or array_ptr[20] causes a SIGSEV vs. + array_ptr[0]. Status: developer-discretion if and only if the variable is assigned a value "shortly after" declaration. @@ -1242,9 +1353,9 @@ struct *ptr = NULL; Example: -ShouldWeBlockThis(); -ContainsAnImage(); -IsWebPageBlank(); +should_we_block_this(); +contains_an_image(); +is_web_page_blank(); @@ -1273,7 +1384,7 @@ IsWebPageBlank(); Example: -for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ ) +for ( size_t cnt = 0; cnt < block_list_length(); cnt++ ) { .... } @@ -1282,10 +1393,10 @@ for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ ) 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 blockListLength() call, it might even be creating and + 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 blockListLength() is a function + 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, @@ -1294,15 +1405,15 @@ for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ ) Example: -size_t len = blockListLength(); +size_t len = block_list_length(); -for ( size_t cnt = 0; cnt < len; cnt ++ ) +for ( size_t cnt = 0; cnt < len; cnt++ ) { .... } - Exceptions: if the value of blockListLength() *may* - change or could *potentially* change, then you must code the + 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. @@ -1508,7 +1619,7 @@ switch( hash_string( cmd ) ) 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 ABEND condition. + load_config). Or it may really be an abort condition. Status: Programmer discretion is advised. @@ -1567,8 +1678,7 @@ switch( hash_string( cmd ) ) assumptions about whether it is signed or unsigned, or about how long it is. Do not compare a size_t against another variable of a different type (or even against a constant) - without casting one of the values. Try to avoid using size_t if - you can. + without casting one of the values. @@ -1600,7 +1710,7 @@ long c = 0; Exceptions: when you want to declare a bunch of loop variables or other trivial variables; feel free to declare them - on 1 line. You should, although, provide a good comment on + on one line. You should, although, provide a good comment on their functions. Status: developer-discretion. @@ -1638,7 +1748,7 @@ list, then it should definitely be allocated via `malloc'. responsible for ensuring that deletion is timely (i.e. not too soon, not too late). This is known as "low-coupling" and is a "good thing (tm)". You may need to offer a - free/unload/destuctor type function to accommodate this. + free/unload/destructor type function to accommodate this. Example: @@ -1678,7 +1788,7 @@ static void unload_re_filterfile( void *f ) { ... } "Uncertain" new code and/or changes to - existing code, use FIXME + existing code, use FIXME or XXX Explanation: @@ -1715,19 +1825,15 @@ static void unload_re_filterfile( void *f ) { ... } Example for file comments: -const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $"; +const char FILENAME_rcs[] = "$Id$"; /********************************************************************* * * File : $Source$ * * Purpose : (Fill me in with a good description!) * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * Privoxy team. http://www.privoxy.org/ - * - * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and - * Junkbusters Corporation. http://www.junkbusters.com + * Copyright : Written by and Copyright (C) 2001-2009 + * the Privoxy team. http://www.privoxy.org/ * * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General @@ -1743,12 +1849,10 @@ const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49: * * The GNU General Public License should be included with * this file. If not, you can view it at - * http://www.gnu.org/copyleft/gpl.html - * or write to the Free Software Foundation, Inc., 59 - * Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * - * Revisions : - * $Log$ + * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html + * or write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 , + * USA * *********************************************************************/ @@ -1775,19 +1879,15 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; #ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.33 2002/04/12 03:49:53 hal9 Exp $" +#define FILENAME_H_VERSION "$Id$" /********************************************************************* * * File : $Source$ * * Purpose : (Fill me in with a good description!) * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * Privoxy team. http://www.privoxy.org/ - * - * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and - * Junkbusters Corporation. http://www.junkbusters.com + * Copyright : Written by and Copyright (C) 2001-2009 + * the Privoxy team. http://www.privoxy.org/ * * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General @@ -1803,12 +1903,10 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; * * The GNU General Public License should be included with * this file. If not, you can view it at - * http://www.gnu.org/copyleft/gpl.html - * or write to the Free Software Foundation, Inc., 59 - * Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * - * Revisions : - * $Log$ + * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html + * or write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 , + * USA * *********************************************************************/ @@ -1920,7 +2018,7 @@ at sourceforge. Three simple steps: intelligent (keep it short and precise). - Do not mail to the mailinglist (we cannot keep track on issues there). + Do not mail to the mailing list (we cannot keep track on issues there). @@ -1947,13 +2045,93 @@ at sourceforge. Three simple steps: gmake (GNU's version of make), autoconf, cvs. + + Version numbers + + + First you need to determine which version number the release will have. + Privoxy version numbers consist of three numbers, + separated by dots, like in X.Y.Z (e.g. 3.0.0), where: + + + + X, the version major, is rarely ever changed. It is increased by one if + turning a development branch into stable substantially changes the functionality, + user interface or configuration syntax. Majors 1 and 2 were + Junkbuster, and 3 will be the first stable + Privoxy release. + + + + + Y, the version minor, represents the branch within the major version. + At any point in time, there are two branches being maintained: + The stable branch, with an even minor, say, 2N, in which no functionality is + being added and only bug-fixes are made, and 2N+1, the development branch, in + which the further development of Privoxy takes + place. + This enables us to turn the code upside down and inside out, while at the same time + providing and maintaining a stable version. + The minor is reset to zero (and one) when the major is incremented. When a development + branch has matured to the point where it can be turned into stable, the old stable branch + 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the + new stable branch 2N+2, and a new development branch 2N+3 is opened. + + + + + Z, the point or sub version, represents a release of the software within a branch. + It is therefore incremented immediately before each code freeze. + In development branches, only the even point versions correspond to actual releases, + while the odd ones denote the evolving state of the sources on CVS in between. + It follows that Z is odd on CVS in development branches most of the time. There, it gets + increased to an even number immediately before a code freeze, and is increased to an odd + number again immediately thereafter. + This ensures that builds from CVS snapshots are easily distinguished from released versions. + The point version is reset to zero when the minor changes. + + + Stable branches work a little differently, since there should be + little to no development happening in such branches. Remember, + only bugfixes, which presumably should have had some testing + before 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 -> 3.0.2. + + + + + + In summary, the main CVS trunk is the development branch where new + features are being worked on for the next stable series. This should + almost always be where the most activity takes place. There is always at + least one stable branch from the trunk, e.g now it is + 3.0, which is only used to release stable versions. + Once the initial *.0 release of the stable branch has been done, then as a + rule, only bugfixes that have had prior testing should be committed to + the stable branch. Once there are enough bugfixes to justify a new + release, the version of this branch is again incremented Example: 3.0.0 + -> 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! + - In the following text, replace X, Y and Z with the actual version number - (X = major, Y = minor, Z = point): + 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 v_3_0_branch at the moment). + + - Before the Release + Before the Release: Freeze The following must be done by one of the developers prior to each new release. @@ -1964,24 +2142,27 @@ at sourceforge. Three simple steps: Make sure that everybody who has worked on the code in the last couple of days has had a chance to yell no! in case - they have pending changes/fixes in their pipelines. + they have pending changes/fixes in their pipelines. Announce the + freeze so that nobody will interfere with last minute changes. - Increment the version number and increase or reset the RPM release number - in configure.in as appropriate. + Increment the version number (point from odd to even in development + branches!) in configure.in. (RPM spec files + will need to be incremented as well.) - If the default actionsfile has changed since last - release, bump up its version info in this line: + If default.action has changed since last + release (i.e. software release or standalone actions file release), + bump up its version info to A.B in this line: {+add-header{X-Actions-File-Version: A.B} -filter -no-popups} - + Then change the version info in doc/webserver/actions/index.php, @@ -1990,16 +2171,42 @@ at sourceforge. Three simple steps: - If the HTML documentation is not in sync with the SGML sources - you need to regenerate it. (If in doubt, just do it.) See the + All documentation should be rebuild after the version bump. + 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 + 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 Section "Updating the webserver" in this manual for details. - Commit all files that were changed in the above steps! + The User Manual is also used for context + sensitive help for the CGI editor. This is version sensitive, so that + the user will get appropriate help for his/her release. So with + each release a fresh version should be uploaded to the webserver + (this is in addition to the main User Manual + link from the main page since we need to keep manuals for various + versions available). The CGI pages will link to something like + http://privoxy.org/$(VERSION)/user-manual/. This + will need to be updated for each new release. There is no Makefile + target for this at this time!!! It needs to be done manually. + + + All developers should look at the ChangeLog and + make sure noteworthy changes are referenced. + + + + + Commit all files that were changed in the above steps! + + Tag all files in CVS with the version number with @@ -2007,6 +2214,23 @@ at sourceforge. Three simple steps: Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc. + + + If the release was in a development branch, increase the point version + from even to odd (X.Y.(Z+1)) again in configure.in and + commit your change. + + + + + On the webserver, copy the user manual to a new top-level directory + called X.Y.Z. This ensures that help links from the CGI + pages, which have the version as a prefix, will go into the right version of the manual. + If this is a development branch release, also symlink X.Y.(Z-1) + to X.Y.Z and X.Y.(Z+1) to + . (i.e. dot). + + @@ -2021,16 +2245,17 @@ at sourceforge. Three simple steps: For all types of packages, including the source tarball, you must make sure that you build from clean sources by exporting - the right version from CVS into an empty directory:. + the right version from CVS into an empty directory (just press return when + asked for a password): mkdir dist # delete or choose different name if it already exists cd dist - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current - + cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login + cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current + @@ -2040,11 +2265,142 @@ at sourceforge. Three simple steps: on exactly the same code. + + + Every significant release of Privoxy has included at least one + package that either had incorrect versions of files, missing files, + or incidental leftovers from a previous build process that gave + unknown numbers of users headaches to try to figure out what was + wrong. PLEASE, make sure you are using pristene sources, and are + following the prescribed process! + + + Please find additional instructions for the source tarball and the - individual platform dependent binary packages below. + individual platform dependent binary packages below. And details + on the Sourceforge release process below that. + + Note on Privoxy Packaging + + Please keep these general guidelines in mind when putting together + your package. These apply to all platforms! + + + + + + Privoxy requires + write access to: all *.action files, all + logfiles, and the trust file. You will + need to determine the best way to do this for your platform. + + + + + Please include up to date documentation. At a bare minimum: + + + + LICENSE (top-level directory) + + + + + README (top-level directory) + + + + + AUTHORS (top-level directory) + + + + + man page (top-level directory, Unix-like + platforms only) + + + + + The User Manual (doc/webserver/user-manual/) + + + + + FAQ (doc/webserver/faq/) + + + + Also suggested: Developer Manual + (doc/webserver/developer-manual) and ChangeLog + (top-level directory). FAQ and the manuals are + HTML docs. There are also text versions in + doc/text/ which could conceivably also be + included. + + + The documentation has been designed such that the manuals are linked + to each other from parallel directories, and should be packaged + that way. privoxy-index.html can also be + included and can serve as a focal point for docs and other links of + interest (and possibly renamed to index.html). + This should be one level up from the manuals. There is a link also + on this page to an HTMLized version of the man page. To avoid 404 for + this, it is in CVS as + doc/webserver/man-page/privoxy-man-page.html, + and should be included along with the manuals. There is also a + css stylesheets that can be included for better presentation: + p_doc.css. This should be in the same directory + with privoxy-index.html, (i.e. one level up from + the manual directories). + + + + + user.action and user.filter + are designed for local preferences. Make sure these do not get overwritten! + config should not be overwritten either. This + has especially important configuration data in it. + trust should be left in tact as well. + + + + + Other configuration files (default.action and + default.filter) should be installed as the new + defaults, but all previously installed configuration files should be + preserved as backups. This is just good manners :-) These files are + likely to change between releases and contain important new features + and bug fixes. + + + + + Please check platform specific notes in this doc, if you haven't + done Privoxy packaging before for other platform + specific issues. Conversely, please add any notes that you know + are important for your platform (or contact one of the doc + maintainers to do this if you can't). + + + + + Packagers should do a clean install of their + package after building it. So any previous installs should be + removed first to ensure the integrity of the newly built package. + Then run the package for a while to make sure there are no + obvious problems, before uploading. + + + + + + + + Source Tarball First, make sure that you have freshly exported the right @@ -2055,7 +2411,7 @@ at sourceforge. Three simple steps: cd current autoheader && autoconf && ./configure - + Then do: @@ -2063,7 +2419,7 @@ at sourceforge. Three simple steps: make tarball-dist - + To upload the package to Sourceforge, simply issue @@ -2071,7 +2427,7 @@ at sourceforge. Three simple steps: make tarball-upload - + Go to the displayed URL and release the file publicly on Sourceforge. @@ -2080,37 +2436,58 @@ at sourceforge. Three simple steps: - SuSE or Red Hat + 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 version into an empty directory. (See "Building and releasing - packages" above). Then run: + 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 + correct. The RPM release numbers for each version start at one. Hence it must + be reset to one if this is the first RPM for + dist which is built from version + X.Y.Z. Check the + 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 - make suse-dist (or make redhat-dist) - + make dist-dist + To upload the package to Sourceforge, simply issue - make suse-upload (or make redhat-upload) - + 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. - Use the release notes and çhange log from the source tarball package. + Use the release notes and change log from the source tarball package. @@ -2122,8 +2499,8 @@ at sourceforge. Three simple steps: - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup - + cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup + You will need a mix of development tools. @@ -2143,7 +2520,7 @@ at sourceforge. Three simple steps: installExeName='privoxyos2_setup_X.Y.Z.exe' - + Next, edit the IJB.wis file so the release number matches @@ -2152,7 +2529,7 @@ at sourceforge. Three simple steps: PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z" - + You're now ready to build. Run: @@ -2160,7 +2537,7 @@ at sourceforge. Three simple steps: os2build - + You will find the WarpIN-installable executable in the @@ -2178,7 +2555,7 @@ at sourceforge. Three simple steps: ssh cf.sourceforge.net - + Choose the right operating system (not the Debian one). @@ -2190,7 +2567,7 @@ at sourceforge. Three simple steps: cd current autoheader && autoconf && ./configure - + Then run @@ -2198,7 +2575,7 @@ at sourceforge. Three simple steps: gmake solaris-dist - + which creates a gzip'ed tar archive. Sadly, you cannot use make @@ -2222,8 +2599,8 @@ at sourceforge. Three simple steps: - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup - + cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup + Then you can build the package. This is fully automated, and is @@ -2232,9 +2609,9 @@ at sourceforge. Three simple steps: - cd winsetup - make - + cd winsetup + make + Now you can manually rename privoxy_setup.exe to @@ -2246,31 +2623,48 @@ at sourceforge. Three simple steps: Debian - 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. - + First, make sure that you have freshly exported the + right version into an empty directory. (See + "Building and releasing packages" above). Then add a log + entry to debian/changelog, if it is not + already there, for example by running: + + + + debchange -v &p-version;-&p-status;-1 "New upstream version" + + + + Then, run: + + + + dpkg-buildpackage -rfakeroot -us -uc -b + + + + This will create + ../privoxy_&p-version;-&p-status;-1_i386.deb + which can be uploaded. To upload the package to Sourceforge, simply + issue + + + + make debian-upload + + - Mac OSX + Mac OS X 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 OSX setup module: + packages" above). Then get the Mac OS X setup module: - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup - + cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup + Then run: @@ -2279,7 +2673,7 @@ at sourceforge. Three simple steps: cd osxsetup build - + This will run autoheader, autoconf and @@ -2295,8 +2689,8 @@ at sourceforge. Three simple steps: -zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg - + zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg + You can then upload privoxyosx_setup_x.y.z.zip anonymously to @@ -2308,12 +2702,12 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg FreeBSD - Login to Sourceforge's compilefarm via ssh: + Login to Sourceforge's compile-farm via ssh: ssh cf.sourceforge.net - + Choose the right operating system. @@ -2325,7 +2719,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg cd current autoheader && autoconf && ./configure - + Then run: @@ -2333,7 +2727,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg gmake freebsd-dist - + which creates a gzip'ed tar archive. Sadly, you cannot use make @@ -2354,7 +2748,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg cd current autoheader && autoconf && ./configure - + Then do FIXME. @@ -2371,7 +2765,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg cd current autoheader && autoconf && ./configure - + Then do FIXME. @@ -2385,7 +2779,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg ssh cf.sourceforge.net - + Choose the right operating system. @@ -2397,7 +2791,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg cd current autoheader && autoconf && ./configure - + Then run: @@ -2405,7 +2799,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg make aix-dist - + which creates a gzip'ed tar archive. Sadly, you cannot use make @@ -2417,6 +2811,64 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg + + Uploading and Releasing Your Package + + After the package is ready, it is time to upload it + to SourceForge, and go through the release steps. The upload + is done via FTP: + + + + + + Upload to: ftp://upload.sourceforge.net/incoming + + + + + user: anonymous + + + + + password: ijbswa-developers@lists.sourceforge.net + + + + + + Or use the make targets as described above. + + + Once this done go to https://sourceforge.net/project/admin/editpackages.php?group_id=11118, + making sure you are logged in. Find your target platform in the + second column, and click Add Release. You will + then need to create a new release for your package, using the format + of $VERSION ($CODE_STATUS), e.g. &p-version; + (beta). + + + Now just follow the prompts. Be sure to add any appropriate Release + notes. You should see your freshly uploaded packages in + Step 2. Add Files To This Release. Check the + appropriate box(es). Remember at each step to hit the + Refresh/Submit buttons! You should now see your + file(s) listed in Step 3. Fill out the forms with the appropriate + information for your platform, being sure to hit Update + for each file. If anyone is monitoring your platform, check the + email box at the very bottom to notify them of + the new package. This should do it! + + + If you have made errors, or need to make changes, you can go through + essentially the same steps, but select Edit Release, + instead of Add Release. + + + After the Release @@ -2425,7 +2877,10 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg mailing list, Subject: "Version X.Y.Z available for download". Be sure to include the download - location, the release notes and the change log. + location, the release notes and the Changelog. Also, post an + updated News item on the project page Sourceforge, and update the Home + page and docs linked from the Home page (see below). Other news sites + and release oriented sites, such as Freshmeat, should also be notified. @@ -2434,31 +2889,33 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Update the Webserver - When updating the webserver, please follow these steps to make - sure that no broken links, incosistent contents or permission - problems will occur: + The webserver should be updated at least with each stable release. When + updating, please follow these steps to make sure that no broken links, + inconsistent contents or permission problems will occur (as it has many + times in the past!): - If you have changed anything in the documentation source SGML files, - do: + If you have changed anything in the stable-branch documentation source + SGML files, do: - make dok # (or make redkat-dok if make dok doesn't work for you) - + make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you) + That will generate doc/webserver/user-manual, doc/webserver/developer-manual, - doc/webserver/faq and + doc/webserver/faq, + doc/pdf/*.pdf and doc/webserver/index.html automatically. - If you changed the manual page source, generate + If you changed the manual page sources, generate doc/webserver/man-page/privoxy-man-page.html by running make man. (This is - a separate target due to dependencies on some obscure perl scripts. - See comments in GNUmakefile.) + a separate target due to dependencies on some obscure perl scripts + [now in CVS, but not well tested]. See comments in GNUmakefile.) If you want to add new files to the webserver, create them locally in @@ -2466,12 +2923,13 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg create new directories under doc/webserver). - Next, commit any changes from the above steps to CVS. All set? Then do + Next, commit any changes from the above steps to CVS. All set? + If these are docs in the stable branch, then do: make webserver - + This will do the upload to the @@ -2480,7 +2938,9 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Please do NOT use any other means of transferring - files to the webserver to avoid permission problems. + files to the webserver to avoid permission problems. Also, please do not + upload docs from development branches or versions. The publicly posted + docs should be in sync with the last official release. @@ -2491,22 +2951,30 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg - - Copyright and History -Copyright + +Privoxy Copyright, License and History + ©right; + + +License + + &license; + + + History &history; - + See also @@ -2537,6 +3005,172 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: developer-manual.sgml,v $ + Revision 2.28 2009/05/16 13:27:21 fabiankeil + Remove CVS revision logs. TODO item #33. + + Revision 2.27 2009/02/19 02:20:22 hal9 + Make some links in seealso conditional. Man page is now privoxy only links. + + Revision 2.26 2009/02/12 16:08:26 fabiankeil + Declare the code stable. + + Revision 2.25 2009/02/12 15:37:05 fabiankeil + Update templates. + + Revision 2.24 2009/01/13 16:50:35 fabiankeil + The standard.action file is gone. + + Revision 2.23 2008/09/26 17:02:01 fabiankeil + - Break some more CVS substitutions in examples. + - Remove Junkbusters reference in example header + for new files. + + Revision 2.22 2008/08/30 15:37:35 fabiankeil + Update entities. + + Revision 2.21 2008/08/16 08:51:28 fabiankeil + Update version-related entities. + + Revision 2.20 2008/06/14 13:21:24 fabiankeil + Prepare for the upcoming 3.0.9 beta release. + + Revision 2.19 2008/05/12 11:13:33 fabiankeil + Clarify that Privoxy is licensed under GPL version 2. + + Revision 2.18 2008/02/04 12:14:06 fabiankeil + Change "Edit Packages" URL to use https. + + Revision 2.17 2008/02/03 21:37:41 hal9 + Apply patch from Mark: s/OSX/OS X/ + + Revision 2.16 2008/01/19 17:52:38 hal9 + Re-commit to fix various minor issues for new release. + + Revision 2.15 2008/01/19 15:03:05 hal9 + Doc sources tagged for 3.0.8 release. + + Revision 2.14 2008/01/17 01:49:51 hal9 + Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon + enough. + + Revision 2.13 2007/10/30 17:59:31 fabiankeil + - Bump p-version, p-status and copyright date. + - Mention that the manual is out of date. + - Don't use examples with HardToReadCamelCase after + explaining that we actually don't like that. + - Minor cosmetics. + + Revision 2.12 2006/11/14 01:57:46 hal9 + Dump all docs prior to 3.0.6 release. Various minor changes to faq and user + manual. + + Revision 2.11 2006/09/26 02:36:29 hal9 + Fix broken link per bug tracker. + + Revision 2.10 2006/09/22 01:27:55 hal9 + Final commit of probably various minor changes here and there. Unless + something changes this should be ready for pending release. + + Revision 2.9 2006/09/14 02:30:07 hal9 + Fix ijbswa cvs links. Update notes on release process, and which config files + should be overwritten and which not. + + Revision 2.8 2006/08/22 23:35:01 hal9 + Fix email address, cvs URI, address branching changes and various other + small updates. + + Revision 2.7 2006/07/18 14:48:50 david__schmidt + Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + with what was really the latest development (the v_3_0_branch branch) + + Revision 1.46.2.11 2002/12/11 13:12:15 hal9 + Rewrite cvs write access give-away section. + + Revision 1.46.2.10 2002/09/26 21:53:45 hal9 + Changes to reflect recent change in stable branch commit policy (hopefully + clearer now). + + Revision 1.46.2.9 2002/09/26 01:21:40 hal9 + Porting 3.1.1 changes: more on cvs and branches, more on versions and + releases. + + Revision 1.46.2.8 2002/08/17 00:16:10 hal9 + Add note on updating webserver for User-manual/CGI editor, which is version + dependent (and different from main UM link). + + Revision 1.46.2.7 2002/08/14 17:29:25 hal9 + Add small notes on post-release steps, and uploading docs to webserver. + + Revision 1.46.2.6 2002/08/10 11:40:25 oes + Added disclaimer about probably being out-of-date and two small hints + + Revision 1.46.2.5 2002/08/09 01:15:12 hal9 + Added some notes on pre-release steps (test builds first, update ChangeLog). + + Revision 1.46.2.4 2002/05/29 00:30:59 mal0rd + Fixed a little formatting. Clarified debian section. + + Revision 1.46.2.3 2002/05/28 04:32:45 hal9 + Change hints on bundling index.html to privoxy-index.html + + Revision 1.46.2.2 2002/05/26 17:04:24 hal9 + -Spellcheck, very minor edits, and sync across branches + + Revision 1.48 2002/05/26 12:48:31 roro + Add releasing information about Debian. + + Revision 1.47 2002/05/26 04:55:11 mal0rd + Added debian-dist and debian-upload targets. Also documented usage. + + Revision 1.46 2002/05/22 17:15:00 oes + Updated intro + + Revision 1.45 2002/05/19 23:01:54 hal9 + Add small section on general packaging guidelines (e.g. actions files must + be writable). + + Revision 1.44 2002/05/15 03:55:17 hal9 + Fix ulink -> link, and minor modification to release process section for + clarification. + + Revision 1.43 2002/05/10 01:48:19 hal9 + This is mostly proposed copyright/licensing additions and changes. Docs + are still GPL, but licensing and copyright are more visible. Also, copyright + changed in doc header comments (eliminate references to JB except FAQ). + + Revision 1.42 2002/05/05 20:26:02 hal9 + Sorting out license vs copyright in these docs. + + Revision 1.41 2002/05/04 08:44:44 swa + bumped version + + Revision 1.40 2002/05/04 00:43:43 hal9 + -Remove TOC/first page kludge with proper stylesheet fix. + -Combined the two very brief sections: Intro and Quickstart. + + Revision 1.39 2002/05/02 15:08:25 oes + Added explanation about version numbers and RPM package revisions + + Revision 1.38 2002/04/29 02:20:31 hal9 + Add info on steps for uploading and the release process on SF. + + Revision 1.37 2002/04/26 17:23:29 swa + bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot + + Revision 1.36 2002/04/26 05:25:23 hal9 + Mass commit to catch a few scattered fixes. + + Revision 1.35 2002/04/17 15:16:15 oes + Added link to docbook crash course + + Revision 1.34 2002/04/15 23:39:32 oes + - Extended & fixed the release section + - Added CVS guideline sections + - Separated webserver section from release section + - Commented out boilerplate inclusion (If you don't know yet what it is, + you shouldn't mess with its code ;-) + - Nits & fixes + Revision 1.33 2002/04/12 03:49:53 hal9 Spell checked. Clarification on where docs are kept. @@ -2585,7 +3219,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg More boilerplate text for use across multiple docs. Revision 1.20 2002/04/04 03:28:27 david__schmidt - Add Mac OSX section + Add Mac OS X section Revision 1.19 2002/04/03 15:09:42 david__schmidt Add OS/2 build section