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.
+ incremented immediately after each software release. 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.
+ 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 +
In summary, the main Git 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 + 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!
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 + require a separate submission to the main trunk, since these are separate development trees within Git. 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).
The following must be done by one of the developers prior to each new release.
Increment the version number (point from odd to even in development branches!) in configure.in and update the code status (CODE_STATUS="xxx") to one of "alpha", "beta" or - "stable". Rebuild configure and GNUMakefile to make sure the updated values are being used.
+Update the code status (CODE_STATUS="xxx") in configure.in to one of "alpha", "beta" or "stable".
Use the dok-release target to update the sgml documentation source files.
+Rebuild configure and GNUMakefile to make sure the updated values are being used.
+
+ $ autoheader && autoconf # rebuild configure +$ ./configure # rebuild GNUmakefile+ |
+
make dok-release to update the sgml documentation source files.
If action file processing has changed and is not backward-compatible, make sure the @@ -120,37 +125,86 @@ for-privoxy-version=3.0.11
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) fall in this category. - README, 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.
-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.
+Create the change log:
+
+ $ git tag + # to see the tags + $ git log [last release tag]..HEAD > /tmp/log + # get the commit log since the last release + $ utils/makeChangeLog /tmp/log > /tmp/change.log + # reformat the commit log+ |
+
Edit /tmp/change.log to remove trivial changes and group the changes under + general headings like:
+
+ - Bug fixes: +- Action file improvements: +- Filter file improvements: +- General improvements: +- Documentation improvements: +- Build system improvements: +- Code cleanups: +- Privoxy-Log-Parser: +- Privoxy-Regression-Test:+ |
+
Add the contents of /tmp/change.log to the start of ChangeLog and re-create doc/source/changelog.sgml:
+
+ + $ utils/changelog2doc.pl /tmp/change.log >| doc/source/changelog.sgml+ |
+
All developers should look at the ChangeLog and make sure noteworthy changes are referenced.
All documentation should be rebuilt:
+
+ $ make man + $ make dok + $ make dok-man + $ make dok-tidy + $ make config-file+ |
+
Commit all files that were changed in the above steps!
Tag all files in CVS with the version number with "cvs tag - v_X_Y_Z". Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
+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.
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.
+Tag all files in Git with the version number with "cvs tag + v_X_Y_Z". Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
On the webserver, copy the user manual to a new top-level directory called released is always the source tarball.
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 (just press return when asked for a password):
+ right version from Git into an empty directory (just press return when asked for a password):| @@ -179,7 +233,7 @@ for-privoxy-version=3.0.11 |
Do NOT change a single bit, including, but not limited - to version information after export from CVS. This is to make sure that all release packages, and with them, all + to version information after export from Git. This is to make sure that all release packages, and with them, all future bug reports, are based on exactly the same code.
cd current - autoheader && autoconf && ./configure+ autoheader && autoconf && ./configure |
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 As the only exception to not changing anything after export from Git, 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
@@ -430,7 +484,7 @@ for-privoxy-version=3.0.11
cd current
- autoheader && autoconf && ./configure
+ autoheader && autoconf && ./configure
@@ -448,33 +502,36 @@ for-privoxy-version=3.0.11
cd current
- autoheader && autoconf && ./configure
+ autoheader && autoconf && ./configure
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.
+Note that the docbook generated files might need some hand editing, so the Windows build makefile does not + rebuild the docs.
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:
+ into an empty directory. (See "Building and releasing packages" above). +Then you can build the package. This is fully automated, and is controlled by windows/GNUmakefile. All you need to do is:
- - cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup+ cd windows + make |
Then you can build the package. This is fully automated, and is controlled by winsetup/GNUmakefile. All you need to do is:
+Now you can manually rename privoxy_setup.exe to privoxy_setup_X.Y.Z.exe, and the build directory to privoxy_X.Y.Z. Create a .zip file of the newly renamed privoxy_X.Y.Z + directory, GPG sign the installer and zip file,
- cd winsetup - make+ $ gpg --armor --detach --sign privoxy_setup_X.Y.Z.exe + $ gpg --armor --detach --sign privoxy_X.Y.Z.zip |
Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and upload it to SourceForge. When releasing the package on - SourceForge, use the release notes and Change Log from the source tarball package.
+and upload the files to SourceForge.
+When releasing the package on SourceForge, use the release notes and Change Log from the source tarball + package.
- debchange -v 3.0.27-UNRELEASED-1 "New upstream version"+ debchange -v 3.0.29-UNRELEASED-1 "New upstream version" |
This will create ../privoxy_3.0.27-UNRELEASED-1_i386.deb which can be uploaded. To +
This will create ../privoxy_3.0.29-UNRELEASED-1_i386.deb which can be uploaded. To upload the package to Sourceforge, simply issue
|
@@ -538,7 +595,7 @@ for-privoxy-version=3.0.11
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: +Check out the module from Git as follows into a folder parallel to the exported privoxy source:
|