doc/webserver/developer-manual/newrelease.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2 "http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4 <head>
   5   <title>Releasing a New Version</title>
   6   <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
   7   <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
   8   <link rel="PREVIOUS" title="Testing Guidelines" href="testing.html">
   9   <link rel="NEXT" title="Update the Webserver" href="webserver-update.html">
  10   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
  11   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  12 </head>
  13 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
  14   <div class="NAVHEADER">
  15     <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
  16       <tr>
  17         <th colspan="3" align="center">Privoxy Developer Manual</th>
  18       </tr>
  19       <tr>
  20         <td width="10%" align="left" valign="bottom"><a href="testing.html" accesskey="P">Prev</a></td>
  21         <td width="80%" align="center" valign="bottom"></td>
  22         <td width="10%" align="right" valign="bottom"><a href="webserver-update.html" accesskey="N">Next</a></td>
  23       </tr>
  24     </table>
  25     <hr align="left" width="100%">
  26   </div>
  27   <div class="SECT1">
  28     <h1 class="SECT1"><a name="NEWRELEASE" id="NEWRELEASE">6. Releasing a New Version</a></h1>
  29     <p>When we release versions of <span class="APPLICATION">Privoxy</span>, our work leaves our cozy secret lab and
  30     has to work in the cold RealWorld[tm]. Once it is released, there is no way to call it back, so it is very
  31     important that great care is taken to ensure that everything runs fine, and not to introduce problems in the very
  32     last minute.</p>
  33     <p>So when releasing a new version, please adhere exactly to the procedure outlined in this chapter.</p>
  34     <p>The following programs are required to follow this process: <tt class="FILENAME">ncftpput</tt> (ncftp),
  35     <tt class="FILENAME">scp, ssh</tt> (ssh), <tt class="FILENAME">gmake</tt> (GNU's version of make), autoconf,
  36     cvs.</p>
  37     <div class="SECT2">
  38       <h2 class="SECT2"><a name="VERSIONNUMBERS" id="VERSIONNUMBERS">6.1. Version numbers</a></h2>
  39       <p>First you need to determine which version number the release will have. <span class=
  40       "APPLICATION">Privoxy</span> version numbers consist of three numbers, separated by dots, like in X.Y.Z (e.g.
  41       3.0.0), where:</p>
  42       <ul>
  43         <li>
  44           <p>X, the version major, is rarely ever changed. It is increased by one if turning a development branch into
  45           stable substantially changes the functionality, user interface or configuration syntax. Majors 1 and 2 were
  46           <span class="APPLICATION">Junkbuster</span>, and 3 will be the first stable <span class=
  47           "APPLICATION">Privoxy</span> release.</p>
  48         </li>
  49         <li>
  50           <p>Y, the version minor, represents the branch within the major version. At any point in time, there are two
  51           branches being maintained: The stable branch, with an even minor, say, 2N, in which no functionality is being
  52           added and only bug-fixes are made, and 2N+1, the development branch, in which the further development of
  53           <span class="APPLICATION">Privoxy</span> takes place. This enables us to turn the code upside down and inside
  54           out, while at the same time providing and maintaining a stable version. The minor is reset to zero (and one)
  55           when the major is incremented. When a development branch has matured to the point where it can be turned into
  56           stable, the old stable branch 2N is given up (i.e. no longer maintained), the former development branch 2N+1
  57           becomes the new stable branch 2N+2, and a new development branch 2N+3 is opened.</p>
  58         </li>
  59         <li>
  60           <p>Z, the point or sub version, represents a release of the software within a branch. It is therefore
  61           incremented immediately after each software release. The point version is reset to zero when the minor
  62           changes.</p>
  63           <p>Stable branches work a little differently, since there should be little to no development happening in
  64           such branches. Remember, only bugfixes, which presumably should have had some testing before being committed.
  65           Stable branches will then have their version reported as <tt class="LITERAL">0.0.0</tt>, during that period
  66           between releases when changes are being added. This is to denote that this code is <span class=
  67           "emphasis"><i class="EMPHASIS">not for release</i></span>. Then as the release nears, the version is bumped
  68           according: e.g. <tt class="LITERAL">3.0.1 -&#62; 0.0.0 -&#62; 3.0.2</tt>.</p>
  69         </li>
  70       </ul>
  71       <p>In summary, the main Git trunk is the development branch where new features are being worked on for the next
  72       stable series. This should almost always be where the most activity takes place. There is always at least one
  73       stable branch from the trunk, e.g now it is <tt class="LITERAL">3.0</tt>, which is only used to release stable
  74       versions. Once the initial *.0 release of the stable branch has been done, then as a rule, only bugfixes that
  75       have had prior testing should be committed to the stable branch. Once there are enough bugfixes to justify a new
  76       release, the version of this branch is again incremented Example: 3.0.0 -&#62; 3.0.1 -&#62; 3.0.2, etc are all
  77       stable releases from within the stable branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
  78       taking place. If any questions, please post to the devel list <span class="emphasis"><i class=
  79       "EMPHASIS">before</i></span> committing to a stable branch!</p>
  80       <p>Developers should remember too that if they commit a bugfix to the stable branch, this will more than likely
  81       require a separate submission to the main trunk, since these are separate development trees within Git. If you
  82       are working on both, then this would require at least two separate check outs (i.e main trunk, <span class=
  83       "emphasis"><i class="EMPHASIS">and</i></span> the stable release branch, which is <tt class=
  84       "LITERAL">v_3_0_branch</tt> at the moment).</p>
  85     </div>
  86     <div class="SECT2">
  87       <h2 class="SECT2"><a name="BEFORERELEASE" id="BEFORERELEASE">6.2. Before the Release: Freeze</a></h2>
  88       <p>The following <span class="emphasis"><i class="EMPHASIS">must be done by one of the developers</i></span>
  89       prior to each new release.</p>
  90       <ul>
  91         <li>
  92           <p>Make sure that everybody who has worked on the code in the last couple of days has had a chance to yell
  93           <span class="QUOTE">"no!"</span> in case they have pending changes/fixes in their pipelines. Announce the
  94           freeze so that nobody will interfere with last minute changes.</p>
  95         </li>
  96         <li>
  97           <p>Update the code status (CODE_STATUS="xxx") in configure.in to one of "alpha", "beta" or "stable".</p>
  98         </li>
  99         <li>
 100           <p>Rebuild configure and GNUMakefile to make sure the updated values are being used.</p>
 101           <table border="0" bgcolor="#E0E0E0" width="90%">
 102             <tr>
 103               <td>
 104                 <pre class="PROGRAMLISTING">$ autoheader &#38;&#38; autoconf     # rebuild configure
 105 $ ./configure                # rebuild GNUmakefile</pre>
 106               </td>
 107             </tr>
 108           </table>
 109         </li>
 110         <li>
 111           <p><b class="COMMAND">make dok-release</b> to update the sgml documentation source files.</p>
 112         </li>
 113         <li>
 114           <p>If action file processing has changed and is not backward-compatible, make sure the
 115           "for-privoxy-version=x.y.z" minimum version number in default.action.master has been updated:</p>
 116           <table border="0" bgcolor="#E0E0E0" width="90%">
 117             <tr>
 118               <td>
 119                 <pre class="PROGRAMLISTING">{{settings}}
 120 #############################################################################
 121 #MASTER# COMMENT: The minimum Privoxy version:
 122 for-privoxy-version=3.0.11</pre>
 123               </td>
 124             </tr>
 125           </table>
 126         </li>
 127         <li>
 128           <p>Create the change log:</p>
 129           <table border="0" bgcolor="#E0E0E0" width="90%">
 130             <tr>
 131               <td>
 132                 <pre class="PROGRAMLISTING">  $ git tag
 133   #   to see the tags
 134   $ git log [last release tag]..HEAD &gt; /tmp/log
 135   #   get the commit log since the last release
 136   $ utils/makeChangeLog /tmp/log &gt; /tmp/change.log
 137   #   reformat the commit log</pre>
 138               </td>
 139             </tr>
 140           </table>
 141           <p>Edit <tt class="FILENAME">/tmp/change.log</tt> to remove trivial changes and group the changes under
 142           general headings like:</p>
 143           <table border="0" bgcolor="#E0E0E0" width="90%">
 144             <tr>
 145               <td>
 146                 <pre class="PROGRAMLISTING">- Bug fixes:
 147 - Action file improvements:
 148 - Filter file improvements:
 149 - General improvements:
 150 - Documentation improvements:
 151 - Build system improvements:
 152 - Code cleanups:
 153 - Privoxy-Log-Parser:
 154 - Privoxy-Regression-Test:</pre>
 155               </td>
 156             </tr>
 157           </table>
 158           <p>Add the contents of <tt class="FILENAME">/tmp/change.log</tt> to the start of <tt class=
 159           "FILENAME">ChangeLog</tt> and re-create <tt class="FILENAME">doc/source/changelog.sgml</tt>:</p>
 160           <table border="0" bgcolor="#E0E0E0" width="90%">
 161             <tr>
 162               <td>
 163                 <pre class=
 164                 "PROGRAMLISTING">  $ utils/changelog2doc.pl /tmp/change.log &gt;| doc/source/changelog.sgml</pre>
 165               </td>
 166             </tr>
 167           </table>
 168         </li>
 169         <li>
 170           <p>All developers should look at the <tt class="FILENAME">ChangeLog</tt> and make sure noteworthy changes are
 171           referenced.</p>
 172         </li>
 173         <li>
 174           <p>All documentation should be rebuilt:</p>
 175           <table border="0" bgcolor="#E0E0E0" width="90%">
 176             <tr>
 177               <td>
 178                 <pre class="PROGRAMLISTING">  $ make dok
 179   $ make dok-tidy
 180   $ make man
 181   $ make config-file</pre>
 182               </td>
 183             </tr>
 184           </table>Finished docs should be then be committed to Git (for those without the ability to build these). Some
 185           docs may require rather obscure processing tools. <tt class="FILENAME">config</tt>, the man page (and the
 186           html version of the man page) fall in this category. README, the man page, AUTHORS, and config should all
 187           also be committed to Git for other packagers. The formal docs should be uploaded to the webserver. See the
 188           section <a href="webserver-update.html" target="_top">"Updating the webserver"</a> in this manual for
 189           details.
 190         </li>
 191         <li>
 192           <p><span class="emphasis"><i class="EMPHASIS">Commit all files that were changed in the above
 193           steps!</i></span></p>
 194         </li>
 195         <li>
 196           <p>The <i class="CITETITLE">User Manual</i> is also used for context sensitive help for the CGI editor. This
 197           is version sensitive, so that the user will get appropriate help for his/her release. So with each release a
 198           fresh version should be uploaded to the webserver (this is in addition to the main <i class="CITETITLE">User
 199           Manual</i> link from the main page since we need to keep manuals for various versions available). The CGI
 200           pages will link to something like <tt class="LITERAL">http://privoxy.org/$(VERSION)/user-manual/</tt>. This
 201           will need to be updated for each new release. There is no Makefile target for this at this time!!! It needs
 202           to be done manually.</p>
 203         </li>
 204         <li>
 205           <p>Tag all files in Git with the version number with <span class="QUOTE">"<b class="COMMAND">cvs tag
 206           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>
 207         </li>
 208         <li>
 209           <p>On the webserver, copy the user manual to a new top-level directory called <tt class=
 210           "FILENAME">X.Y.Z</tt>. This ensures that help links from the CGI pages, which have the version as a prefix,
 211           will go into the right version of the manual. If this is a development branch release, also symlink
 212           <tt class="FILENAME">X.Y.(Z-1)</tt> to <tt class="FILENAME">X.Y.Z</tt> and <tt class=
 213           "FILENAME">X.Y.(Z+1)</tt> to <tt class="FILENAME">.</tt> (i.e. dot).</p>
 214         </li>
 215       </ul>
 216     </div>
 217     <div class="SECT2">
 218       <h2 class="SECT2"><a name="THERELEASE" id="THERELEASE">6.3. Building and Releasing the Packages</a></h2>
 219       <p>Now the individual packages can be built and released. Note that for GPL reasons the first package to be
 220       released is always the source tarball.</p>
 221       <p>For <span class="emphasis"><i class="EMPHASIS">all</i></span> types of packages, including the source tarball,
 222       <span class="emphasis"><i class="EMPHASIS">you must make sure that you build from clean sources by exporting the
 223       right version from Git into an empty directory</i></span> (just press return when asked for a password):</p>
 224       <table border="0" bgcolor="#E0E0E0" width="100%">
 225         <tr>
 226           <td>
 227             <pre class="PROGRAMLISTING">  mkdir dist # delete or choose different name if it already exists
 228   cd dist
 229   cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
 230   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</pre>
 231           </td>
 232         </tr>
 233       </table>
 234       <p><span class="emphasis"><i class="EMPHASIS">Do NOT change</i></span> a single bit, including, but not limited
 235       to version information after export from Git. This is to make sure that all release packages, and with them, all
 236       future bug reports, are based on exactly the same code.</p>
 237       <div class="WARNING">
 238         <table class="WARNING" border="1" width="100%">
 239           <tr>
 240             <td align="center"><b>Warning</b></td>
 241           </tr>
 242           <tr>
 243             <td align="left">
 244               <p>Every significant release of Privoxy has included at least one package that either had incorrect
 245               versions of files, missing files, or incidental leftovers from a previous build process that gave unknown
 246               numbers of users headaches to try to figure out what was wrong. PLEASE, make sure you are using pristene
 247               sources, and are following the prescribed process!</p>
 248             </td>
 249           </tr>
 250         </table>
 251       </div>
 252       <p>Please find additional instructions for the source tarball and the individual platform dependent binary
 253       packages below. And details on the Sourceforge release process below that.</p>
 254       <div class="SECT3">
 255         <h3 class="SECT3"><a name="PACK-GUIDELINES" id="PACK-GUIDELINES">6.3.1. Note on Privoxy Packaging</a></h3>
 256         <p>Please keep these general guidelines in mind when putting together your package. These apply to <span class=
 257         "emphasis"><i class="EMPHASIS">all</i></span> platforms!</p>
 258         <ul>
 259           <li>
 260             <p><span class="APPLICATION">Privoxy</span> <span class="emphasis"><i class="EMPHASIS">requires</i></span>
 261             write access to: all <tt class="FILENAME">*.action</tt> files, all logfiles, and the <tt class=
 262             "FILENAME">trust</tt> file. You will need to determine the best way to do this for your platform.</p>
 263           </li>
 264           <li>
 265             <p>Please include up to date documentation. At a bare minimum:</p>
 266             <table border="0">
 267               <tbody>
 268                 <tr>
 269                   <td><tt class="FILENAME">LICENSE</tt> (top-level directory)</td>
 270                 </tr>
 271               </tbody>
 272             </table>
 273             <table border="0">
 274               <tbody>
 275                 <tr>
 276                   <td><tt class="FILENAME">README</tt> (top-level directory)</td>
 277                 </tr>
 278               </tbody>
 279             </table>
 280             <table border="0">
 281               <tbody>
 282                 <tr>
 283                   <td><tt class="FILENAME">AUTHORS</tt> (top-level directory)</td>
 284                 </tr>
 285               </tbody>
 286             </table>
 287             <table border="0">
 288               <tbody>
 289                 <tr>
 290                   <td><tt class="FILENAME">man page</tt> (top-level directory, Unix-like platforms only)</td>
 291                 </tr>
 292               </tbody>
 293             </table>
 294             <table border="0">
 295               <tbody>
 296                 <tr>
 297                   <td><tt class="FILENAME">The User Manual</tt> (doc/webserver/user-manual/)</td>
 298                 </tr>
 299               </tbody>
 300             </table>
 301             <table border="0">
 302               <tbody>
 303                 <tr>
 304                   <td><tt class="FILENAME">FAQ</tt> (doc/webserver/faq/)</td>
 305                 </tr>
 306               </tbody>
 307             </table>
 308             <p>Also suggested: <tt class="FILENAME">Developer Manual</tt> (doc/webserver/developer-manual) and
 309             <tt class="FILENAME">ChangeLog</tt> (top-level directory). <tt class="FILENAME">FAQ</tt> and the manuals
 310             are HTML docs. There are also text versions in <tt class="FILENAME">doc/text/</tt> which could conceivably
 311             also be included.</p>
 312             <p>The documentation has been designed such that the manuals are linked to each other from parallel
 313             directories, and should be packaged that way. <tt class="FILENAME">privoxy-index.html</tt> can also be
 314             included and can serve as a focal point for docs and other links of interest (and possibly renamed to
 315             <tt class="FILENAME">index.html</tt>). This should be one level up from the manuals. There is a link also
 316             on this page to an HTMLized version of the man page. To avoid 404 for this, it is in Git as <tt class=
 317             "FILENAME">doc/webserver/man-page/privoxy-man-page.html</tt>, and should be included along with the
 318             manuals. There is also a css stylesheets that can be included for better presentation: <tt class=
 319             "FILENAME">p_doc.css</tt>. This should be in the same directory with <tt class=
 320             "FILENAME">privoxy-index.html</tt>, (i.e. one level up from the manual directories).</p>
 321           </li>
 322           <li>
 323             <p><tt class="FILENAME">user.action</tt> and <tt class="FILENAME">user.filter</tt> are designed for local
 324             preferences. Make sure these do not get overwritten! <tt class="FILENAME">config</tt> should not be
 325             overwritten either. This has especially important configuration data in it. <tt class="FILENAME">trust</tt>
 326             should be left in tact as well.</p>
 327           </li>
 328           <li>
 329             <p>Other configuration files (<tt class="FILENAME">default.action</tt> and <tt class=
 330             "FILENAME">default.filter</tt>) should be installed as the new defaults, but all previously installed
 331             configuration files should be preserved as backups. This is just good manners :-) These files are likely to
 332             change between releases and contain important new features and bug fixes.</p>
 333           </li>
 334           <li>
 335             <p>Please check platform specific notes in this doc, if you haven't done <span class=
 336             "QUOTE">"Privoxy"</span> packaging before for other platform specific issues. Conversely, please add any
 337             notes that you know are important for your platform (or contact one of the doc maintainers to do this if
 338             you can't).</p>
 339           </li>
 340           <li>
 341             <p>Packagers should do a <span class="QUOTE">"clean"</span> install of their package after building it. So
 342             any previous installs should be removed first to ensure the integrity of the newly built package. Then run
 343             the package for a while to make sure there are no obvious problems, before uploading.</p>
 344           </li>
 345         </ul>
 346       </div>
 347       <div class="SECT3">
 348         <h3 class="SECT3"><a name="NEWRELEASE-TARBALL" id="NEWRELEASE-TARBALL">6.3.2. Source Tarball</a></h3>
 349         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 350         into an empty directory</i></span>. (See "Building and releasing packages" above). Then run:</p>
 351         <table border="0" bgcolor="#E0E0E0" width="100%">
 352           <tr>
 353             <td>
 354               <pre class="PROGRAMLISTING">  cd current
 355   autoheader &#38;&#38; autoconf &#38;&#38; ./configure</pre>
 356             </td>
 357           </tr>
 358         </table>
 359         <p>Then do:</p>
 360         <table border="0" bgcolor="#E0E0E0" width="100%">
 361           <tr>
 362             <td>
 363               <pre class="PROGRAMLISTING">  make tarball-dist</pre>
 364             </td>
 365           </tr>
 366         </table>
 367         <p>To upload the package to Sourceforge, simply issue</p>
 368         <table border="0" bgcolor="#E0E0E0" width="100%">
 369           <tr>
 370             <td>
 371               <pre class="PROGRAMLISTING">  make tarball-upload</pre>
 372             </td>
 373           </tr>
 374         </table>
 375         <p>Go to the displayed URL and release the file publicly on Sourceforge. For the change log field, use the
 376         relevant section of the <tt class="FILENAME">ChangeLog</tt> file.</p>
 377       </div>
 378       <div class="SECT3">
 379         <h3 class="SECT3"><a name="NEWRELEASE-RPM" id="NEWRELEASE-RPM">6.3.3. SuSE, Conectiva or Red Hat RPM</a></h3>
 380         <p>In following text, replace <tt class="REPLACEABLE"><i>dist</i></tt> with either <span class=
 381         "QUOTE">"rh"</span> for Red Hat or <span class="QUOTE">"suse"</span> for SuSE.</p>
 382         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 383         into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
 384         <p>As the only exception to not changing anything after export from Git, now examine the file <tt class=
 385         "FILENAME">privoxy-</tt><tt class="REPLACEABLE"><i>dist</i></tt><tt class="FILENAME">.spec</tt> and make sure
 386         that the version information and the RPM release number are correct. The RPM release numbers for each version
 387         start at one. Hence it must be reset to one if this is the first RPM for <tt class=
 388         "REPLACEABLE"><i>dist</i></tt> which is built from version X.Y.Z. Check the <a href=
 389         "https://sourceforge.net/project/showfiles.php?group_id=11118" target="_top">file list</a> if unsure. Else, it
 390         must be set to the highest already available RPM release number for that version plus one.</p>
 391         <p>Then run:</p>
 392         <table border="0" bgcolor="#E0E0E0" width="100%">
 393           <tr>
 394             <td>
 395               <pre class="PROGRAMLISTING">  cd current
 396   autoheader &#38;&#38; autoconf &#38;&#38; ./configure</pre>
 397             </td>
 398           </tr>
 399         </table>
 400         <p>Then do</p>
 401         <table border="0" bgcolor="#E0E0E0" width="100%">
 402           <tr>
 403             <td>
 404               <pre class="PROGRAMLISTING">  make <tt class="REPLACEABLE"><i>dist</i></tt>-dist</pre>
 405             </td>
 406           </tr>
 407         </table>
 408         <p>To upload the package to Sourceforge, simply issue</p>
 409         <table border="0" bgcolor="#E0E0E0" width="100%">
 410           <tr>
 411             <td>
 412               <pre class="PROGRAMLISTING">  make <tt class="REPLACEABLE"><i>dist</i></tt>-upload <tt class=
 413               "REPLACEABLE"><i>rpm_packagerev</i></tt></pre>
 414             </td>
 415           </tr>
 416         </table>
 417         <p>where <tt class="REPLACEABLE"><i>rpm_packagerev</i></tt> is the RPM release number as determined above. Go
 418         to the displayed URL and release the file publicly on Sourceforge. Use the release notes and change log from
 419         the source tarball package.</p>
 420       </div>
 421       <div class="SECT3">
 422         <h3 class="SECT3"><a name="NEWRELEASE-OS2" id="NEWRELEASE-OS2">6.3.4. OS/2</a></h3>
 423         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 424         into an empty directory</i></span>. (See "Building and releasing packages" above). Then get the OS/2 Setup
 425         module:</p>
 426         <table border="0" bgcolor="#E0E0E0" width="100%">
 427           <tr>
 428             <td>
 429               <pre class=
 430               "PROGRAMLISTING">  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup</pre>
 431             </td>
 432           </tr>
 433         </table>
 434         <p>You will need a mix of development tools. The main compilation takes place with IBM Visual Age C++. Some
 435         ancillary work takes place with GNU tools, available from various sources like hobbes.nmsu.edu. Specificially,
 436         you will need <tt class="FILENAME">autoheader</tt>, <tt class="FILENAME">autoconf</tt> and <tt class=
 437         "FILENAME">sh</tt> tools. The packaging takes place with WarpIN, available from various sources, including its
 438         home page: <a href="http://www.xworkplace.org/" target="_top">xworkplace</a>.</p>
 439         <p>Change directory to the <tt class="FILENAME">os2setup</tt> directory. Edit the os2build.cmd file to set the
 440         final executable filename. For example,</p>
 441         <table border="0" bgcolor="#E0E0E0" width="100%">
 442           <tr>
 443             <td>
 444               <pre class="PROGRAMLISTING">  installExeName='privoxyos2_setup_X.Y.Z.exe'</pre>
 445             </td>
 446           </tr>
 447         </table>
 448         <p>Next, edit the <tt class="FILENAME">IJB.wis</tt> file so the release number matches in the <tt class=
 449         "FILENAME">PACKAGEID</tt> section:</p>
 450         <table border="0" bgcolor="#E0E0E0" width="100%">
 451           <tr>
 452             <td>
 453               <pre class="PROGRAMLISTING">  PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"</pre>
 454             </td>
 455           </tr>
 456         </table>
 457         <p>You're now ready to build. Run:</p>
 458         <table border="0" bgcolor="#E0E0E0" width="100%">
 459           <tr>
 460             <td>
 461               <pre class="PROGRAMLISTING">  os2build</pre>
 462             </td>
 463           </tr>
 464         </table>
 465         <p>You will find the WarpIN-installable executable in the <tt class="FILENAME">./files</tt> directory. Upload
 466         this anonymously to <tt class="FILENAME">uploads.sourceforge.net/incoming</tt>, create a release for it, and
 467         you're done. Use the release notes and Change Log from the source tarball package.</p>
 468       </div>
 469       <div class="SECT3">
 470         <h3 class="SECT3"><a name="NEWRELEASE-SOLARIS" id="NEWRELEASE-SOLARIS">6.3.5. Solaris</a></h3>
 471         <p>Login to Sourceforge's compilefarm via ssh:</p>
 472         <table border="0" bgcolor="#E0E0E0" width="100%">
 473           <tr>
 474             <td>
 475               <pre class="PROGRAMLISTING">  ssh cf.sourceforge.net</pre>
 476             </td>
 477           </tr>
 478         </table>
 479         <p>Choose the right operating system (not the Debian one). When logged in, <span class="emphasis"><i class=
 480         "EMPHASIS">make sure that you have freshly exported the right version into an empty directory</i></span>. (See
 481         "Building and releasing packages" above). Then run:</p>
 482         <table border="0" bgcolor="#E0E0E0" width="100%">
 483           <tr>
 484             <td>
 485               <pre class="PROGRAMLISTING">  cd current
 486   autoheader &#38;&#38; autoconf &#38;&#38; ./configure</pre>
 487             </td>
 488           </tr>
 489         </table>
 490         <p>Then run</p>
 491         <table border="0" bgcolor="#E0E0E0" width="100%">
 492           <tr>
 493             <td>
 494               <pre class="PROGRAMLISTING">  gmake solaris-dist</pre>
 495             </td>
 496           </tr>
 497         </table>
 498         <p>which creates a gzip'ed tar archive. Sadly, you cannot use <b class="COMMAND">make solaris-upload</b> on the
 499         Sourceforge machine (no ncftpput). You now have to manually upload the archive to Sourceforge's ftp server and
 500         release the file publicly. Use the release notes and Change Log from the source tarball package.</p>
 501       </div>
 502       <div class="SECT3">
 503         <h3 class="SECT3"><a name="NEWRELEASE-WINDOWS" id="NEWRELEASE-WINDOWS">6.3.6. Windows</a></h3>
 504         <p>Note that the docbook generated files might need some hand editing, so the Windows build makefile does not
 505         rebuild the docs.</p>
 506         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 507         into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
 508         <p>Then you can build the package. This is fully automated, and is controlled by <tt class=
 509         "FILENAME">windows/GNUmakefile</tt>. All you need to do is:</p>
 510         <table border="0" bgcolor="#E0E0E0" width="100%">
 511           <tr>
 512             <td>
 513               <pre class="PROGRAMLISTING">  cd windows
 514   make</pre>
 515             </td>
 516           </tr>
 517         </table>
 518         <p>Now you can manually rename <tt class="FILENAME">privoxy_setup.exe</tt> to <tt class=
 519         "FILENAME">privoxy_setup_X.Y.Z.exe</tt>, and the <tt class="FILENAME">build</tt> directory to <tt class=
 520         "FILENAME">privoxy_X.Y.Z</tt>. Create a .zip file of the newly renamed <tt class="FILENAME">privoxy_X.Y.Z</tt>
 521         directory, GPG sign the installer and zip file,</p>
 522         <table border="0" bgcolor="#E0E0E0" width="100%">
 523           <tr>
 524             <td>
 525               <pre class="PROGRAMLISTING">  $ gpg --armor --detach --sign <tt class=
 526               "FILENAME">privoxy_setup_X.Y.Z.exe</tt>
 527   $ gpg --armor --detach --sign <tt class="FILENAME">privoxy_X.Y.Z.zip</tt></pre>
 528             </td>
 529           </tr>
 530         </table>
 531         <p>and upload the files to SourceForge.</p>
 532         <p>When releasing the package on SourceForge, use the release notes and Change Log from the source tarball
 533         package.</p>
 534       </div>
 535       <div class="SECT3">
 536         <h3 class="SECT3"><a name="NEWRELEASE-DEBIAN" id="NEWRELEASE-DEBIAN">6.3.7. Debian</a></h3>
 537         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 538         into an empty directory</i></span>. (See "Building and releasing packages" above). Then add a log entry to
 539         <tt class="FILENAME">debian/changelog</tt>, if it is not already there, for example by running:</p>
 540         <table border="0" bgcolor="#E0E0E0" width="100%">
 541           <tr>
 542             <td>
 543               <pre class="PROGRAMLISTING">  debchange -v 3.0.27-UNRELEASED-1 "New upstream version"</pre>
 544             </td>
 545           </tr>
 546         </table>
 547         <p>Then, run:</p>
 548         <table border="0" bgcolor="#E0E0E0" width="100%">
 549           <tr>
 550             <td>
 551               <pre class="PROGRAMLISTING">  dpkg-buildpackage -rfakeroot -us -uc -b</pre>
 552             </td>
 553           </tr>
 554         </table>
 555         <p>This will create <tt class="FILENAME">../privoxy_3.0.27-UNRELEASED-1_i386.deb</tt> which can be uploaded. To
 556         upload the package to Sourceforge, simply issue</p>
 557         <table border="0" bgcolor="#E0E0E0" width="100%">
 558           <tr>
 559             <td>
 560               <pre class="PROGRAMLISTING">  make debian-upload</pre>
 561             </td>
 562           </tr>
 563         </table>
 564       </div>
 565       <div class="SECT3">
 566         <h3 class="SECT3"><a name="NEWRELEASE-MACOSX" id="NEWRELEASE-MACOSX">6.3.8. Mac OS X</a></h3>
 567         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 568         into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
 569         <p>There are three modules available in the Git repository for use on Mac OS X, though technically only two of
 570         them generate a release (the other can be used to install from source).</p>
 571         <div class="SECT4">
 572           <h4 class="SECT4"><a name="OS-X-OSXPACKAGEBUILDER-MODULE" id="OS-X-OSXPACKAGEBUILDER-MODULE">6.3.8.1.
 573           OSXPackageBuilder module</a></h4>
 574           <p>The OSXPackageBuilder module generates OS X installer packages supporting all Macs running OS X 10.4 and
 575           above. Obtain it from Git as follows into a folder parallel to the exported privoxy source:</p>
 576           <table border="0" bgcolor="#E0E0E0" width="100%">
 577             <tr>
 578               <td>
 579                 <pre class=
 580                 "PROGRAMLISTING">  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder</pre>
 581               </td>
 582             </tr>
 583           </table>
 584           <p>The module contains complete instructions on its usage in the file <tt class="FILENAME">OS X Package
 585           Builder HOWTO.txt</tt>.</p>
 586           <p>Once the package(s) have been generated, you can then upload them directly to the Files section of the
 587           Sourceforge project in the Macintosh (OS X) folder. Each new version release of Privoxy should have a new
 588           subfolder created in which to store its files. Please ensure that the folder contains a readme file that
 589           makes it clear which package is for whichversion of OS X.</p>
 590         </div>
 591         <div class="SECT4">
 592           <h4 class="SECT4"><a name="OS-X-OSXSETUP-MODULE" id="OS-X-OSXSETUP-MODULE">6.3.8.2. osxsetup module
 593           (DEPRECATED)</a></h4>
 594           <p><span class="emphasis"><i class="EMPHASIS">This module is deprecated since the installer it generates
 595           places all Privoxy files in one folder in a non-standard location, and supports only Intel Macs running OS X
 596           10.6 or higher.</i></span></p>
 597           <p>Check out the module from Git as follows into a folder parallel to the exported privoxy source:</p>
 598           <table border="0" bgcolor="#E0E0E0" width="100%">
 599             <tr>
 600               <td>
 601                 <pre class=
 602                 "PROGRAMLISTING">  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup</pre>
 603               </td>
 604             </tr>
 605           </table>
 606           <p>Then run:</p>
 607           <table border="0" bgcolor="#E0E0E0" width="100%">
 608             <tr>
 609               <td>
 610                 <pre class="PROGRAMLISTING">  cd osxsetup
 611   build</pre>
 612               </td>
 613             </tr>
 614           </table>
 615           <p>This will run <tt class="FILENAME">autoheader</tt>, <tt class="FILENAME">autoconf</tt> and <tt class=
 616           "FILENAME">configure</tt> as well as <tt class="FILENAME">make</tt>. Finally, it will copy over the necessary
 617           files to the ./osxsetup/files directory for further processing by <tt class="FILENAME">PackageMaker</tt>.</p>
 618           <p>Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package name to match the
 619           release, and hit the "Create package" button. If you specify ./Privoxy.pkg as the output package name, you
 620           can then create the distributable zip file with the command:</p>
 621           <table border="0" bgcolor="#E0E0E0" width="100%">
 622             <tr>
 623               <td>
 624                 <pre class="PROGRAMLISTING">  zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</pre>
 625               </td>
 626             </tr>
 627           </table>
 628           <p>You can then upload this file directly to the Files section of the Sourceforge project in the Macintosh
 629           (OS X) folder. Each new version release of Privoxy should have a new subfolder created in which to store its
 630           files. Please ensure that the folder contains a readme file that makes it clear which version(s) of OS X the
 631           package supports.</p>
 632         </div>
 633         <div class="SECT4">
 634           <h4 class="SECT4"><a name="OS-X-MACSETUP-MODULE" id="OS-X-MACSETUP-MODULE">6.3.8.3. macsetup module</a></h4>
 635           <p>The macsetup module is ideal if you wish to build and install Privoxy from source on a single machine.</p>
 636           <p>Check out the module from Git as follows into a folder parallel to the exported privoxy source:</p>
 637           <table border="0" bgcolor="#E0E0E0" width="100%">
 638             <tr>
 639               <td>
 640                 <pre class=
 641                 "PROGRAMLISTING">  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup</pre>
 642               </td>
 643             </tr>
 644           </table>
 645           <p>The module contains complete instructions on its usage in its <tt class="FILENAME">README</tt> file. The
 646           end result will be the exported version of Privoxy installed on the build machine.</p>
 647         </div>
 648       </div>
 649       <div class="SECT3">
 650         <h3 class="SECT3"><a name="NEWRELEASE-FREEBSD" id="NEWRELEASE-FREEBSD">6.3.9. FreeBSD</a></h3>
 651         <p>Update the www/privoxy port and submit a diff upstream. For details see the <a href=
 652         "https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/" target="_top">FreeBSD Porter's
 653         Handbook</a>.</p>
 654       </div>
 655     </div>
 656     <div class="SECT2">
 657       <h2 class="SECT2"><a name="RELEASING" id="RELEASING">6.4. Uploading and Releasing Your Package</a></h2>
 658       <p>After the package is ready, it is time to upload it to SourceForge, and go through the release steps. The
 659       upload is done via FTP:</p>
 660       <ul>
 661         <li>
 662           <p>Upload to: <a href="ftp://upload.sourceforge.net/incoming" target=
 663           "_top">ftp://upload.sourceforge.net/incoming</a></p>
 664         </li>
 665         <li>
 666           <p>user: <tt class="LITERAL">anonymous</tt></p>
 667         </li>
 668         <li>
 669           <p>password: <tt class="LITERAL">ijbswa-developers@lists.sourceforge.net</tt></p>
 670         </li>
 671       </ul>
 672       <p>Or use the <b class="COMMAND">make</b> targets as described above.</p>
 673       <p>Once this done go to <a href="https://sourceforge.net/project/admin/editpackages.php?group_id=11118" target=
 674       "_top">https://sourceforge.net/project/admin/editpackages.php?group_id=11118</a>, making sure you are logged in.
 675       Find your target platform in the second column, and click <tt class="LITERAL">Add Release</tt>. You will then
 676       need to create a new release for your package, using the format of <tt class="LITERAL">$VERSION
 677       ($CODE_STATUS)</tt>, e.g. <span class="emphasis"><i class="EMPHASIS">3.0.27 (beta)</i></span>.</p>
 678       <p>Now just follow the prompts. Be sure to add any appropriate Release notes. You should see your freshly
 679       uploaded packages in <span class="QUOTE">"Step 2. Add Files To This Release"</span>. Check the appropriate
 680       box(es). Remember at each step to hit the <span class="QUOTE">"Refresh/Submit"</span> buttons! You should now see
 681       your file(s) listed in Step 3. Fill out the forms with the appropriate information for your platform, being sure
 682       to hit <span class="QUOTE">"Update"</span> for each file. If anyone is monitoring your platform, check the
 683       <span class="QUOTE">"email"</span> box at the very bottom to notify them of the new package. This should do
 684       it!</p>
 685       <p>If you have made errors, or need to make changes, you can go through essentially the same steps, but select
 686       <tt class="LITERAL">Edit Release</tt>, instead of <tt class="LITERAL">Add Release</tt>.</p>
 687     </div>
 688     <div class="SECT2">
 689       <h2 class="SECT2"><a name="AFTERRELEASE" id="AFTERRELEASE">6.5. After the Release</a></h2>
 690       <p>When all (or: most of the) packages have been uploaded and made available, send an email to the <a href=
 691       "mailto:privoxy-announce@lists.privoxy.org" target="_top">announce mailing list</a>, Subject: "Version X.Y.Z
 692       available for download". Be sure to include the <a href=
 693       "https://sourceforge.net/project/showfiles.php?group_id=11118" target="_top">download location</a>, the release
 694       notes and the Changelog. Also, post an updated News item on the project page Sourceforge, and update the Home
 695       page and docs linked from the Home page (see below). Other news sites and release oriented sites, such as
 696       Freshmeat, should also be notified.</p>
 697       <p>Then update the source code for the next version to be released:</p>
 698       <ul>
 699         <li>
 700           <p>Increment the version number and change the code status to "UNRELEASED" in <tt class=
 701           "FILENAME">configure.in</tt></p>
 702         </li>
 703         <li>
 704           <p>Rebuild configure (<span class="QUOTE">"<b class="COMMAND">autoheader &#38;&#38; autoconf</b>"</span>) and
 705           GNUMakefile (<span class="QUOTE">"<b class="COMMAND">./configure</b>"</span>)</p>
 706         </li>
 707         <li>
 708           <p><span class="QUOTE">"<b class="COMMAND">make dok-release</b>"</span> to update the sgml documentation
 709           source files.</p>
 710         </li>
 711         <li>
 712           <p>Commit all your changes.</p>
 713         </li>
 714       </ul>
 715     </div>
 716   </div>
 717   <div class="NAVFOOTER">
 718     <hr align="left" width="100%">
 719     <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
 720       <tr>
 721         <td width="33%" align="left" valign="top"><a href="testing.html" accesskey="P">Prev</a></td>
 722         <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
 723         <td width="33%" align="right" valign="top"><a href="webserver-update.html" accesskey="N">Next</a></td>
 724       </tr>
 725       <tr>
 726         <td width="33%" align="left" valign="top">Testing Guidelines</td>
 727         <td width="34%" align="center" valign="top">&nbsp;</td>
 728         <td width="33%" align="right" valign="top">Update the Webserver</td>
 729       </tr>
 730     </table>
 731   </div>
 732 </body>
 733 </html>