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