<link rel="PREVIOUS" title="Testing Guidelines" href="testing.html">
<link rel="NEXT" title="Update the Webserver" href="webserver-update.html">
<link rel="STYLESHEET" type="text/css" href="../p_doc.css">
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="NAVHEADER">
</li>
<li>
<p>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.</p>
+ incremented immediately after each software release. The point version is reset to zero when the minor
+ changes.</p>
<p>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 <tt class="LITERAL">0.0.0</tt>, during that period
between releases when changes are being added. This is to denote that this code is <span class=
"emphasis"><i class="EMPHASIS">not for release</i></span>. Then as the release nears, the version is bumped
- according: e.g. <tt class="LITERAL">3.0.1 -> 0.0.0 -> 3.0.2</tt>.</p>
+ according: e.g. <tt class="LITERAL">3.0.1 -> 0.0.0 -> 3.0.2</tt>.</p>
</li>
</ul>
- <p>In summary, the main CVS trunk is the development branch where new features are being worked on for the next
+ <p>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 <tt class="LITERAL">3.0</tt>, 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 <span class="emphasis"><i class=
"EMPHASIS">before</i></span> committing to a stable branch!</p>
<p>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, <span class=
"emphasis"><i class="EMPHASIS">and</i></span> the stable release branch, which is <tt class=
"LITERAL">v_3_0_branch</tt> at the moment).</p>
</div>
<div class="SECT2">
- <h2 class="SECT2"><a name="BEFORERELEASE" id="BEFORERELEASE">6.2. Before the Release: Freeze</a></h2>
+ <h2 class="SECT2"><a name="BEFORERELEASE" id="BEFORERELEASE">6.2. Before the Release</a></h2>
<p>The following <span class="emphasis"><i class="EMPHASIS">must be done by one of the developers</i></span>
prior to each new release.</p>
<ul>
freeze so that nobody will interfere with last minute changes.</p>
</li>
<li>
- <p>Increment the version number (point from odd to even in development branches!) in <tt class=
- "FILENAME">configure.in</tt> 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.</p>
+ <p>Update the code status (CODE_STATUS="xxx") in configure.in to one of "alpha", "beta" or "stable".</p>
</li>
<li>
- <p>Use the dok-release target to update the sgml documentation source files.</p>
+ <p>Rebuild configure and GNUMakefile to make sure the updated values are being used.</p>
+ <table border="0" bgcolor="#E0E0E0" width="90%">
+ <tr>
+ <td>
+ <pre class="PROGRAMLISTING">$ autoheader && autoconf # rebuild configure
+$ ./configure # rebuild GNUmakefile</pre>
+ </td>
+ </tr>
+ </table>
+ </li>
+ <li>
+ <p><b class="COMMAND">make dok-release</b> to update the sgml documentation source files.</p>
</li>
<li>
<p>If action file processing has changed and is not backward-compatible, make sure the
</table>
</li>
<li>
- <p>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.
- <tt class="FILENAME">config</tt>, 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.</p>
- </li>
- <li>
- <p>The <i class="CITETITLE">User Manual</i> 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 <i class="CITETITLE">User
- Manual</i> link from the main page since we need to keep manuals for various versions available). The CGI
- pages will link to something like <tt class="LITERAL">http://privoxy.org/$(VERSION)/user-manual/</tt>. 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.</p>
+ <p>Create the change log:</p>
+ <table border="0" bgcolor="#E0E0E0" width="90%">
+ <tr>
+ <td>
+ <pre class="PROGRAMLISTING"> $ 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</pre>
+ </td>
+ </tr>
+ </table>
+ <p>Edit <tt class="FILENAME">/tmp/change.log</tt> to remove trivial changes and group the changes under
+ general headings like:</p>
+ <table border="0" bgcolor="#E0E0E0" width="90%">
+ <tr>
+ <td>
+ <pre class="PROGRAMLISTING">- Bug fixes:
+- Action file improvements:
+- Filter file improvements:
+- General improvements:
+- Documentation improvements:
+- Build system improvements:
+- Code cleanups:
+- Privoxy-Log-Parser:
+- Privoxy-Regression-Test:</pre>
+ </td>
+ </tr>
+ </table>
+ <p>Add the contents of <tt class="FILENAME">/tmp/change.log</tt> to the start of <tt class=
+ "FILENAME">ChangeLog</tt> and re-create <tt class="FILENAME">doc/source/changelog.sgml</tt>:</p>
+ <table border="0" bgcolor="#E0E0E0" width="90%">
+ <tr>
+ <td>
+ <pre class="PROGRAMLISTING">
+ $ utils/changelog2doc.pl /tmp/change.log >| doc/source/changelog.sgml</pre>
+ </td>
+ </tr>
+ </table>
</li>
<li>
<p>All developers should look at the <tt class="FILENAME">ChangeLog</tt> and make sure noteworthy changes are
referenced.</p>
</li>
+ <li>
+ <p>All documentation should be rebuilt:</p>
+ <table border="0" bgcolor="#E0E0E0" width="90%">
+ <tr>
+ <td>
+ <pre class="PROGRAMLISTING"> $ make man
+ $ make dok
+ $ make dok-man
+ $ make dok-tidy
+ $ make config-file</pre>
+ </td>
+ </tr>
+ </table>Finished docs should be then be committed to Git (for those without the ability to build these). Some
+ docs may require rather obscure processing tools. <tt class="FILENAME">config</tt>, 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 Git for other packagers. The formal docs should be uploaded to the webserver. See the
+ section <a href="webserver-update.html" target="_top">"Updating the webserver"</a> in this manual for
+ details.
+ </li>
<li>
<p><span class="emphasis"><i class="EMPHASIS">Commit all files that were changed in the above
steps!</i></span></p>
</li>
<li>
- <p>Tag all files in CVS with the version number with <span class="QUOTE">"<b class="COMMAND">cvs tag
- v_X_Y_Z</b>"</span>. Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.</p>
+ <p>The <i class="CITETITLE">User Manual</i> 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 <i class="CITETITLE">User
+ Manual</i> link from the main page since we need to keep manuals for various versions available). The CGI
+ pages will link to something like <tt class="LITERAL">http://privoxy.org/$(VERSION)/user-manual/</tt>. 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.</p>
</li>
<li>
- <p>If the release was in a development branch, increase the point version from even to odd (X.Y.(Z+1)) again
- in <tt class="FILENAME">configure.in</tt> and commit your change.</p>
+ <p>Tag all files in Git with the version number with <span class="QUOTE">"<b class="COMMAND">cvs tag
+ v_X_Y_Z</b>"</span>. Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.</p>
</li>
<li>
<p>On the webserver, copy the user manual to a new top-level directory called <tt class=
released is always the source tarball.</p>
<p>For <span class="emphasis"><i class="EMPHASIS">all</i></span> types of packages, including the source tarball,
<span class="emphasis"><i class="EMPHASIS">you must make sure that you build from clean sources by exporting the
- right version from CVS into an empty directory</i></span> (just press return when asked for a password):</p>
+ right version from Git into an empty directory</i></span> (just press return when asked for a password):</p>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
</tr>
</table>
<p><span class="emphasis"><i class="EMPHASIS">Do NOT change</i></span> 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.</p>
<div class="WARNING">
<table class="WARNING" border="1" width="100%">
directories, and should be packaged that way. <tt class="FILENAME">privoxy-index.html</tt> can also be
included and can serve as a focal point for docs and other links of interest (and possibly renamed to
<tt class="FILENAME">index.html</tt>). 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 <tt class=
+ on this page to an HTMLized version of the man page. To avoid 404 for this, it is in Git as <tt class=
"FILENAME">doc/webserver/man-page/privoxy-man-page.html</tt>, and should be included along with the
manuals. There is also a css stylesheets that can be included for better presentation: <tt class=
"FILENAME">p_doc.css</tt>. This should be in the same directory with <tt class=
<tr>
<td>
<pre class="PROGRAMLISTING"> cd current
- autoheader && autoconf && ./configure</pre>
+ autoheader && autoconf && ./configure</pre>
</td>
</tr>
</table>
"QUOTE">"rh"</span> for Red Hat or <span class="QUOTE">"suse"</span> for SuSE.</p>
<p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
- <p>As the only exception to not changing anything after export from CVS, now examine the file <tt class=
+ <p>As the only exception to not changing anything after export from Git, now examine the file <tt class=
"FILENAME">privoxy-</tt><tt class="REPLACEABLE"><i>dist</i></tt><tt class="FILENAME">.spec</tt> 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 <tt class=
<tr>
<td>
<pre class="PROGRAMLISTING"> cd current
- autoheader && autoconf && ./configure</pre>
+ autoheader && autoconf && ./configure</pre>
</td>
</tr>
</table>
<tr>
<td>
<pre class="PROGRAMLISTING"> cd current
- autoheader && autoconf && ./configure</pre>
+ autoheader && autoconf && ./configure</pre>
</td>
</tr>
</table>
</div>
<div class="SECT3">
<h3 class="SECT3"><a name="NEWRELEASE-WINDOWS" id="NEWRELEASE-WINDOWS">6.3.6. Windows</a></h3>
- <p>Use the <a href="http://www.fruitbat.org/Cygwin/index.html#cygwincirca" target="_top">Cygwin Time
- Machine</a> to install the last 1.5 version of Cygwin. Run the following commands from within the Cygwin 1.5
- bash shell.</p>
+ <p>Note that the docbook generated files might need some hand editing, so the Windows build makefile does not
+ rebuild the docs.</p>
<p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
- into an empty directory</i></span>. (See "Building and releasing packages" above). Then get the Windows setup
- module:</p>
+ into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
+ <p>Then you can build the package. This is fully automated, and is controlled by <tt class=
+ "FILENAME">windows/GNUmakefile</tt>. All you need to do is:</p>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
- <pre class="PROGRAMLISTING">
- cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup</pre>
+ <pre class="PROGRAMLISTING"> cd windows
+ make</pre>
</td>
</tr>
</table>
- <p>Then you can build the package. This is fully automated, and is controlled by <tt class=
- "FILENAME">winsetup/GNUmakefile</tt>. All you need to do is:</p>
+ <p>Now you can manually rename <tt class="FILENAME">privoxy_setup.exe</tt> to <tt class=
+ "FILENAME">privoxy_setup_X.Y.Z.exe</tt>, and the <tt class="FILENAME">build</tt> directory to <tt class=
+ "FILENAME">privoxy_X.Y.Z</tt>. Create a .zip file of the newly renamed <tt class="FILENAME">privoxy_X.Y.Z</tt>
+ directory, GPG sign the installer and zip file,</p>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
- <pre class="PROGRAMLISTING"> cd winsetup
- make</pre>
+ <pre class="PROGRAMLISTING"> $ gpg --armor --detach --sign <tt class=
+ "FILENAME">privoxy_setup_X.Y.Z.exe</tt>
+ $ gpg --armor --detach --sign <tt class="FILENAME">privoxy_X.Y.Z.zip</tt></pre>
</td>
</tr>
</table>
- <p>Now you can manually rename <tt class="FILENAME">privoxy_setup.exe</tt> to <tt class=
- "FILENAME">privoxy_setup_X_Y_Z.exe</tt>, and upload it to SourceForge. When releasing the package on
- SourceForge, use the release notes and Change Log from the source tarball package.</p>
+ <p>and upload the files to SourceForge.</p>
+ <p>When releasing the package on SourceForge, use the release notes and Change Log from the source tarball
+ package.</p>
</div>
<div class="SECT3">
<h3 class="SECT3"><a name="NEWRELEASE-DEBIAN" id="NEWRELEASE-DEBIAN">6.3.7. Debian</a></h3>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
- <pre class="PROGRAMLISTING"> debchange -v 3.0.27-UNRELEASED-1 "New upstream version"</pre>
+ <pre class="PROGRAMLISTING"> debchange -v 3.0.29-UNRELEASED-1 "New upstream version"</pre>
</td>
</tr>
</table>
</td>
</tr>
</table>
- <p>This will create <tt class="FILENAME">../privoxy_3.0.27-UNRELEASED-1_i386.deb</tt> which can be uploaded. To
+ <p>This will create <tt class="FILENAME">../privoxy_3.0.29-UNRELEASED-1_i386.deb</tt> which can be uploaded. To
upload the package to Sourceforge, simply issue</p>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<h3 class="SECT3"><a name="NEWRELEASE-MACOSX" id="NEWRELEASE-MACOSX">6.3.8. Mac OS X</a></h3>
<p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
- <p>There are three modules available in the CVS repository for use on Mac OS X, though technically only two of
+ <p>There are three modules available in the Git 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).</p>
<div class="SECT4">
<h4 class="SECT4"><a name="OS-X-OSXPACKAGEBUILDER-MODULE" id="OS-X-OSXPACKAGEBUILDER-MODULE">6.3.8.1.
OSXPackageBuilder module</a></h4>
<p>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:</p>
+ above. Obtain it from Git as follows into a folder parallel to the exported privoxy source:</p>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
<p><span class="emphasis"><i class="EMPHASIS">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.</i></span></p>
- <p>Check out the module from CVS as follows into a folder parallel to the exported privoxy source:</p>
+ <p>Check out the module from Git as follows into a folder parallel to the exported privoxy source:</p>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
<div class="SECT4">
<h4 class="SECT4"><a name="OS-X-MACSETUP-MODULE" id="OS-X-MACSETUP-MODULE">6.3.8.3. macsetup module</a></h4>
<p>The macsetup module is ideal if you wish to build and install Privoxy from source on a single machine.</p>
- <p>Check out the module from CVS as follows into a folder parallel to the exported privoxy source:</p>
+ <p>Check out the module from Git as follows into a folder parallel to the exported privoxy source:</p>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
"_top">https://sourceforge.net/project/admin/editpackages.php?group_id=11118</a>, making sure you are logged in.
Find your target platform in the second column, and click <tt class="LITERAL">Add Release</tt>. You will then
need to create a new release for your package, using the format of <tt class="LITERAL">$VERSION
- ($CODE_STATUS)</tt>, e.g. <span class="emphasis"><i class="EMPHASIS">3.0.27 (beta)</i></span>.</p>
+ ($CODE_STATUS)</tt>, e.g. <span class="emphasis"><i class="EMPHASIS">3.0.29 (beta)</i></span>.</p>
<p>Now just follow the prompts. Be sure to add any appropriate Release notes. You should see your freshly
uploaded packages in <span class="QUOTE">"Step 2. Add Files To This Release"</span>. Check the appropriate
box(es). Remember at each step to hit the <span class="QUOTE">"Refresh/Submit"</span> buttons! You should now see
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.</p>
+ <p>Then update the source code for the next version to be released:</p>
+ <ul>
+ <li>
+ <p>Increment the version number and change the code status to "UNRELEASED" in <tt class=
+ "FILENAME">configure.in</tt></p>
+ </li>
+ <li>
+ <p>Rebuild configure (<span class="QUOTE">"<b class="COMMAND">autoheader && autoconf</b>"</span>) and
+ GNUMakefile (<span class="QUOTE">"<b class="COMMAND">./configure</b>"</span>)</p>
+ </li>
+ <li>
+ <p><span class="QUOTE">"<b class="COMMAND">make dok-release</b>"</span> to update the sgml documentation
+ source files.</p>
+ </li>
+ <li>
+ <p>Commit all your changes.</p>
+ </li>
+ </ul>
</div>
</div>
<div class="NAVFOOTER">
projects / privoxy.git / blobdiff