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