From: hal9 Date: Wed, 3 Apr 2002 01:21:17 +0000 (+0000) Subject: Implementing Andreas's suggestions for Release sections. X-Git-Tag: v_2_9_14~253 X-Git-Url: http://www.privoxy.org/gitweb/@default-cgi@/faq/%22https:/@user-manual@?a=commitdiff_plain;h=9eb1467fa22b801e2ddf1da7049767dc12a46af3;p=privoxy.git Implementing Andreas's suggestions for Release sections. --- diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index b723edd9..db044832 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -1,4 +1,9 @@ - + + + + +]> +&p-intro; - Privoxy is a web proxy with advanced filtering - capabilities for protecting privacy, filtering web page content, managing - cookies, controlling access, and removing ads, banners, pop-ups and other - obnoxious Internet junk. Privoxy has a very - flexible configuration and can be customized to suit individual needs and - tastes. Privoxy has application for both - stand-alone systems and multi-user networks. - - - - Privoxy is based on the code of the - Internet Junkbuster. - Junkbuster was originally written by JunkBusters - Corporation, and was released as free open-source software under the GNU GPL. - Stefan Waldherr made many improvements, and started the SourceForge project - to continue development. Other developers have since joined Stefan. - - - - You can find the latest version of the user manual at http://www.privoxy.org/developer-manual/. - Please see the Contact section in the user-manual if you want to contact the + Please see the Contact section of the User Manual on how to contact the developers. @@ -136,6 +136,11 @@ following guidelines for changing stuff in the code. If it is and, of course this, the developer-manual in this format. + + Other, less formal documents (e.g. README, LICENSE) are + maintained as plain text files in the toplevel source + directory. + Packagers are encouraged to include this documentation. For those without the ability to build the docs locally, text versions of @@ -144,7 +149,7 @@ following guidelines for changing stuff in the code. If it is should be fairly current. - Documents are built with the Makefile targets of + 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 @@ -1304,7 +1309,7 @@ static void unload_re_filterfile( void *f ) { ... } Example for file comments: -const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.15 2002/03/30 22:29:47 swa Exp $"; +const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.16 2002/03/31 23:04:40 hal9 Exp $"; /********************************************************************* * * File : $Source$ @@ -1364,7 +1369,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; #ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.15 2002/03/30 22:29:47 swa Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.16 2002/03/31 23:04:40 hal9 Exp $" /********************************************************************* * * File : $Source$ @@ -1462,8 +1467,8 @@ int FUNCTION_NAME( void *param1, const char *x ) Version Control Guidelines - To be filled. note on cvs comments. don't comment what you did, comment -why you did it. + To be filled. note on cvs comments. Don't only comment what you did, + but also why you did it! @@ -1475,7 +1480,7 @@ why you did it. Testplan for releases -Explain release numbers. major, minor. developer releases. etc. + Explain release numbers. major, minor. developer releases. etc. @@ -1526,15 +1531,78 @@ at sourceforge. Three simple steps: Releasing a new version To minimize trouble with distribution contents, webpage - errors and the like, I (Stefan) strongly encourage you + errors and the like, we strongly encourage you to follow this section if you prepare a new release of code or new pages on the webserver. The following programs are required to follow this process: ncftpput (ncftp), scp (ssh), -gmake (GNU's version of make), ???. +gmake (GNU's version of make), autoconf, cvs, ???. + + + Before the Release + + The following must be done by one of the + developers prior to each new release: + + + + + + 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. + + + + + Increment the version number in configure.in in + CVS. Also, the RPM release number in + configure.in. Do NOT touch version information + after export from CVS. All packages will use the + version and release data from configure.in. + Local files should not be changed, except prior to a CVS commit!!! + This way we are all on the same page! + + + + + If the default actionsfile has changed since last release, + bump up its version info 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, + line: '$required_actions_file_version = "A.B";' + + + + + Tag all files in CVS with the version number with + cvs tag v_X_Y_Z (where X = major, Y + = minor, Z = point). Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) + etc. + + + + + The first package uploaded should be the official + tarball release. This is built with the + make tarball-dist Makefile + target, and then can be uploaded with + make tarball-upload (see below). + + + + + + Update the webserver All files must be group-readable and group-writable (or no one else @@ -1543,43 +1611,43 @@ at sourceforge. Three simple steps: create new directories under doc/webserver), then do - - make webserver + + make webserver - Note that make dok creates + Note that make dok + (or make redhat-dok) creates doc/webserver/user-manual, doc/webserver/developer-manual, doc/webserver/faq and doc/webserver/man-page automatically. - Verify on the webserver that the permissions are set correctly. Do - NOT use any other means of transferring files to the webserver. + Please do NOT use any other means of transferring files to the + webserver. make webserver not only + uploads, but will make sure that the appropriate permissions are + preserved for shared group access. - SuSE or RedHat + SuSE or Red Hat - Ensure that you have the latest code version. Hence run + Ensure that you have the latest code version. Hence run: - cvs update . + cd current + 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 - first. If necessary, change the version number of - Privoxy in the - configure.in file. Update the release number - directly in the specific spec file (particularly, set the release - number to 1 if you have increased the version - number before). Run + first. - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure @@ -1587,7 +1655,7 @@ at sourceforge. Three simple steps: - make suse-dist or make redhat-dist + make suse-dist or make redhat-dist @@ -1595,31 +1663,31 @@ at sourceforge. Three simple steps: - make suse-upload or make redhat-upload + make suse-upload or make redhat-upload - Goto the displayed URL and release the file publically on Sourceforge. + Go to the displayed URL and release the file publicly on Sourceforge. OS/2 - Ensure that you have the latest code version. Hence run + Ensure that you have the latest code version. Hence run: - cvs update . + cd current + 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 - first. If necessary, change the version number of - Privoxy in the - configure.in file. Run + first. - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure @@ -1633,28 +1701,28 @@ at sourceforge. Three simple steps: - ssh cf.sourceforge.net + ssh cf.sourceforge.net Choose the right operating system (not the Debian one). If you have - downloaded Privoxy before, + downloaded Privoxy before, - cd current && cvs update . + cd current + 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 If not, please checkout - Privoxy via CVS first. Verify the version number in - configure.in. If necessary, change the version - number. Run + Privoxy via CVS first. Run: - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure @@ -1662,14 +1730,14 @@ at sourceforge. Three simple steps: - gmake solaris-dist + 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 + 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 publically + the file publicly. @@ -1679,17 +1747,17 @@ at sourceforge. Three simple steps: - cvs update . + cd current + 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 - first. If necessary, change the version number of - Privoxy in the - configure.in file. Run + Run: - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure @@ -1699,21 +1767,21 @@ at sourceforge. Three simple steps: Debian - Ensure that you have the latest code version. Hence run + Ensure that you have the latest code version. Hence run: - cvs update . + cd current + 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 - first. If necessary, change the version number of - Privoxy in the - configure.in file. Run + first. Run: - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure @@ -1727,7 +1795,7 @@ at sourceforge. Three simple steps: - ssh cf.sourceforge.net + ssh cf.sourceforge.net @@ -1736,52 +1804,52 @@ at sourceforge. Three simple steps: - cd current && cvs update . + cd current + 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 If not, please checkout - Privoxy via CVS first. Verify the version number in - configure.in. If necessary, change the version - number. Run + Privoxy via CVS first. Run: - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure - Then run + Then run: - make macosx-dist + make macosx-dist - which creates a gzip'ed tar archive. Sadly, you cannot use make - macosx-upload on the Sourceforge machine (no ncftpput). You now have + which creates a gzip'ed tar archive. Sadly, you cannot use make + macosx-upload on the Sourceforge machine (no ncftpput). You now have to manually upload the archive to Sourceforge's ftp server and release - the file publically + the file publicly. FreeBSD Change the version number of Privoxy in the - configure.in file. Run + configure.in file. Run: - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure Then ... - Login to Sourceforge's compilefarm via ssh + Login to Sourceforge's compilefarm via ssh: - ssh cf.sourceforge.net + ssh cf.sourceforge.net @@ -1790,63 +1858,63 @@ at sourceforge. Three simple steps: - cd current && cvs update . + cd current + 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 If not, please checkout - Privoxy via CVS first. Verify the version number in - configure.in. If necessary, change the version - number. Run + Privoxy via CVS first. Run: - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure - Then run + Then run: - gmake freebsd-dist + 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 + 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 publically + the file publicly. Tarball - Ensure that you have the latest code version. Hence run + Ensure that you have the latest code version. Hence run: - cvs update . + cd current + 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 - first. If necessary, change the version number of - Privoxy in the - configure.in file. Run + first. Run: - make clobber - autoheader && autoconf && ./configure + make clobber + autoheader && autoconf && ./configure - Then do + Then do: - make tarball-dist + make tarball-dist @@ -1854,31 +1922,31 @@ at sourceforge. Three simple steps: - make tarball-upload + make tarball-upload - Goto the displayed URL and release the file publically on Sourceforge. + Goto the displayed URL and release the file publicly on Sourceforge. HP-UX 11 - Ensure that you have the latest code version. Hence run + Ensure that you have the latest code version. Hence run: - cvs update . + cd current + 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 - first. If necessary, change the version number of - Privoxy in the - configure.in file. Run + first. Run: - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure @@ -1888,21 +1956,21 @@ at sourceforge. Three simple steps: Amiga OS - Ensure that you have the latest code version. Hence run + Ensure that you have the latest code version. Hence run: - cvs update . + cd current + 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 - first. If necessary, change the version number of - Privoxy in the - configure.in file. Run + first. Run: - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure @@ -1912,47 +1980,47 @@ at sourceforge. Three simple steps: AIX - Login to Sourceforge's compilefarm via ssh + Login to Sourceforge's compilefarm via ssh: - ssh cf.sourceforge.net + ssh cf.sourceforge.net Choose the right operating system. If you have downloaded Privoxy - before, + before: - cd current && cvs update . + cd current + 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 If not, please checkout - Privoxy via CVS first. Verify the version number in - configure.in. If necessary, change the version - number. Run + Privoxy via CVS first. Run: - autoheader && autoconf && ./configure + autoheader && autoconf && ./configure - Then run + Then run: - make aix-dist + 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 + 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 publically + the file publicly. @@ -2005,6 +2073,10 @@ at sourceforge. Three simple steps: Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: developer-manual.sgml,v $ + Revision 1.16 2002/03/31 23:04:40 hal9 + Fleshed out the doc section, and added something for an intro so it was not + blank. + Revision 1.15 2002/03/30 22:29:47 swa wrong make flavour