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>Update the code status (CODE_STATUS="xxx") in <tt class=
 166           "FILENAME">configure.in</tt> to one of "alpha", "beta" or
 167           "stable".</p>
 168         </li>
 169
 170         <li>
 171           <p>If action file processing has changed and is not
 172           backward-compatable, make sure the "for-privoxy-version=x.y.z"
 173           minimum version number in default.action.master has been
 174           updated:</p>
 175
 176           <table border="0" bgcolor="#E0E0E0" width="90%">
 177             <tr>
 178               <td>
 179                 <pre class="PROGRAMLISTING">
 180 {{settings}}
 181 #############################################################################
 182 #MASTER# COMMENT: The minimum Privoxy version:
 183 for-privoxy-version=3.0.11
 184 </pre>
 185               </td>
 186             </tr>
 187           </table>
 188         </li>
 189
 190         <li>
 191           <p>Update the sgml documentation source files with the version
 192           number</p>
 193
 194           <table border="0" bgcolor="#E0E0E0" width="90%">
 195             <tr>
 196               <td>
 197                 <pre class="PROGRAMLISTING">
 198 &lt;!entity p-version "3.0.26"&gt;
 199 </pre>
 200               </td>
 201             </tr>
 202           </table>and set the code status
 203
 204           <table border="0" bgcolor="#E0E0E0" width="90%">
 205             <tr>
 206               <td>
 207                 <pre class="PROGRAMLISTING">
 208 &lt;!entity p-status "stable"&gt;
 209 </pre>
 210               </td>
 211             </tr>
 212           </table>to one of "alpha", "beta" or "stable" in
 213
 214           <table border="0" bgcolor="#E0E0E0" width="90%">
 215             <tr>
 216               <td>
 217                 <pre class="PROGRAMLISTING">
 218   current/doc/source/authors.sgml
 219   current/doc/source/config.sgml
 220   current/doc/source/developer-manual.sgml
 221   current/doc/source/faq.sgml
 222   current/doc/source/install.sgml
 223   current/doc/source/privoxy-man-page.sgml
 224   current/doc/source/readme.sgml
 225   current/doc/source/user-manual.sgml
 226 and in
 227   current/doc/source/webserver/index.sgml
 228 </pre>
 229               </td>
 230             </tr>
 231           </table>
 232         </li>
 233
 234         <li>
 235           <p>All documentation should be rebuild after the version bump.
 236           Finished docs should be then be committed to CVS (for those without
 237           the ability to build these). Some docs may require rather obscure
 238           processing tools. <tt class="FILENAME">config</tt>, the man page
 239           (and the html version of the man page) fall in this category.
 240           REAMDE, the man page, AUTHORS, and config should all also be
 241           committed to CVS for other packagers. The formal docs should be
 242           uploaded to the webserver. See the Section "Updating the webserver"
 243           in this manual for details.</p>
 244         </li>
 245
 246         <li>
 247           <p>The <i class="CITETITLE">User Manual</i> is also used for
 248           context sensitive help for the CGI editor. This is version
 249           sensitive, so that the user will get appropriate help for his/her
 250           release. So with each release a fresh version should be uploaded to
 251           the webserver (this is in addition to the main <i class=
 252           "CITETITLE">User Manual</i> link from the main page since we need
 253           to keep manuals for various versions available). The CGI pages will
 254           link to something like <tt class=
 255           "LITERAL">http://privoxy.org/$(VERSION)/user-manual/</tt>. This
 256           will need to be updated for each new release. There is no Makefile
 257           target for this at this time!!! It needs to be done manually.</p>
 258         </li>
 259
 260         <li>
 261           <p>All developers should look at the <tt class=
 262           "FILENAME">ChangeLog</tt> and make sure noteworthy changes are
 263           referenced.</p>
 264         </li>
 265
 266         <li>
 267           <p><span class="emphasis"><i class="EMPHASIS">Commit all files that
 268           were changed in the above steps!</i></span></p>
 269         </li>
 270
 271         <li>
 272           <p>Tag all files in CVS with the version number with <span class=
 273           "QUOTE">"<b class="COMMAND">cvs tag v_X_Y_Z</b>"</span>. Don't use
 274           vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.</p>
 275         </li>
 276
 277         <li>
 278           <p>If the release was in a development branch, increase the point
 279           version from even to odd (X.Y.(Z+1)) again in <tt class=
 280           "FILENAME">configure.in</tt> and commit your change.</p>
 281         </li>
 282
 283         <li>
 284           <p>On the webserver, copy the user manual to a new top-level
 285           directory called <tt class="FILENAME">X.Y.Z</tt>. This ensures that
 286           help links from the CGI pages, which have the version as a prefix,
 287           will go into the right version of the manual. If this is a
 288           development branch release, also symlink <tt class=
 289           "FILENAME">X.Y.(Z-1)</tt> to <tt class="FILENAME">X.Y.Z</tt> and
 290           <tt class="FILENAME">X.Y.(Z+1)</tt> to <tt class="FILENAME">.</tt>
 291           (i.e. dot).</p>
 292         </li>
 293       </ul>
 294     </div>
 295
 296     <div class="SECT2">
 297       <h2 class="SECT2"><a name="THERELEASE" id="THERELEASE">6.3. Building
 298       and Releasing the Packages</a></h2>
 299
 300       <p>Now the individual packages can be built and released. Note that for
 301       GPL reasons the first package to be released is always the source
 302       tarball.</p>
 303
 304       <p>For <span class="emphasis"><i class="EMPHASIS">all</i></span> types
 305       of packages, including the source tarball, <span class=
 306       "emphasis"><i class="EMPHASIS">you must make sure that you build from
 307       clean sources by exporting the right version from CVS into an empty
 308       directory</i></span> (just press return when asked for a password):</p>
 309
 310       <table border="0" bgcolor="#E0E0E0" width="100%">
 311         <tr>
 312           <td>
 313             <pre class="PROGRAMLISTING">
 314   mkdir dist # delete or choose different name if it already exists
 315   cd dist
 316   cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
 317   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
 318 </pre>
 319           </td>
 320         </tr>
 321       </table>
 322
 323       <p><span class="emphasis"><i class="EMPHASIS">Do NOT change</i></span>
 324       a single bit, including, but not limited to version information after
 325       export from CVS. This is to make sure that all release packages, and
 326       with them, all future bug reports, are based on exactly the same
 327       code.</p>
 328
 329       <div class="WARNING">
 330         <table class="WARNING" border="1" width="100%">
 331           <tr>
 332             <td align="center"><b>Warning</b></td>
 333           </tr>
 334
 335           <tr>
 336             <td align="left">
 337               <p>Every significant release of Privoxy has included at least
 338               one package that either had incorrect versions of files,
 339               missing files, or incidental leftovers from a previous build
 340               process that gave unknown numbers of users headaches to try to
 341               figure out what was wrong. PLEASE, make sure you are using
 342               pristene sources, and are following the prescribed process!</p>
 343             </td>
 344           </tr>
 345         </table>
 346       </div>
 347
 348       <p>Please find additional instructions for the source tarball and the
 349       individual platform dependent binary packages below. And details on the
 350       Sourceforge release process below that.</p>
 351
 352       <div class="SECT3">
 353         <h3 class="SECT3"><a name="PACK-GUIDELINES" id=
 354         "PACK-GUIDELINES">6.3.1. Note on Privoxy Packaging</a></h3>
 355
 356         <p>Please keep these general guidelines in mind when putting together
 357         your package. These apply to <span class="emphasis"><i class=
 358         "EMPHASIS">all</i></span> platforms!</p>
 359
 360         <ul>
 361           <li>
 362             <p><span class="APPLICATION">Privoxy</span> <span class=
 363             "emphasis"><i class="EMPHASIS">requires</i></span> write access
 364             to: all <tt class="FILENAME">*.action</tt> files, all logfiles,
 365             and the <tt class="FILENAME">trust</tt> file. You will need to
 366             determine the best way to do this for your platform.</p>
 367           </li>
 368
 369           <li>
 370             <p>Please include up to date documentation. At a bare
 371             minimum:</p>
 372
 373             <table border="0">
 374               <tbody>
 375                 <tr>
 376                   <td><tt class="FILENAME">LICENSE</tt> (top-level
 377                   directory)</td>
 378                 </tr>
 379               </tbody>
 380             </table>
 381
 382             <table border="0">
 383               <tbody>
 384                 <tr>
 385                   <td><tt class="FILENAME">README</tt> (top-level
 386                   directory)</td>
 387                 </tr>
 388               </tbody>
 389             </table>
 390
 391             <table border="0">
 392               <tbody>
 393                 <tr>
 394                   <td><tt class="FILENAME">AUTHORS</tt> (top-level
 395                   directory)</td>
 396                 </tr>
 397               </tbody>
 398             </table>
 399
 400             <table border="0">
 401               <tbody>
 402                 <tr>
 403                   <td><tt class="FILENAME">man page</tt> (top-level
 404                   directory, Unix-like platforms only)</td>
 405                 </tr>
 406               </tbody>
 407             </table>
 408
 409             <table border="0">
 410               <tbody>
 411                 <tr>
 412                   <td><tt class="FILENAME">The User Manual</tt>
 413                   (doc/webserver/user-manual/)</td>
 414                 </tr>
 415               </tbody>
 416             </table>
 417
 418             <table border="0">
 419               <tbody>
 420                 <tr>
 421                   <td><tt class="FILENAME">FAQ</tt> (doc/webserver/faq/)</td>
 422                 </tr>
 423               </tbody>
 424             </table>
 425
 426             <p>Also suggested: <tt class="FILENAME">Developer Manual</tt>
 427             (doc/webserver/developer-manual) and <tt class=
 428             "FILENAME">ChangeLog</tt> (top-level directory). <tt class=
 429             "FILENAME">FAQ</tt> and the manuals are HTML docs. There are also
 430             text versions in <tt class="FILENAME">doc/text/</tt> which could
 431             conceivably also be included.</p>
 432
 433             <p>The documentation has been designed such that the manuals are
 434             linked to each other from parallel directories, and should be
 435             packaged that way. <tt class="FILENAME">privoxy-index.html</tt>
 436             can also be included and can serve as a focal point for docs and
 437             other links of interest (and possibly renamed to <tt class=
 438             "FILENAME">index.html</tt>). This should be one level up from the
 439             manuals. There is a link also on this page to an HTMLized version
 440             of the man page. To avoid 404 for this, it is in CVS as
 441             <tt class="FILENAME">doc/webserver/man-page/privoxy-man-page.html</tt>,
 442             and should be included along with the manuals. There is also a
 443             css stylesheets that can be included for better presentation:
 444             <tt class="FILENAME">p_doc.css</tt>. This should be in the same
 445             directory with <tt class="FILENAME">privoxy-index.html</tt>,
 446             (i.e. one level up from the manual directories).</p>
 447           </li>
 448
 449           <li>
 450             <p><tt class="FILENAME">user.action</tt> and <tt class=
 451             "FILENAME">user.filter</tt> are designed for local preferences.
 452             Make sure these do not get overwritten! <tt class=
 453             "FILENAME">config</tt> should not be overwritten either. This has
 454             especially important configuration data in it. <tt class=
 455             "FILENAME">trust</tt> should be left in tact as well.</p>
 456           </li>
 457
 458           <li>
 459             <p>Other configuration files (<tt class=
 460             "FILENAME">default.action</tt> and <tt class=
 461             "FILENAME">default.filter</tt>) should be installed as the new
 462             defaults, but all previously installed configuration files should
 463             be preserved as backups. This is just good manners :-) These
 464             files are likely to change between releases and contain important
 465             new features and bug fixes.</p>
 466           </li>
 467
 468           <li>
 469             <p>Please check platform specific notes in this doc, if you
 470             haven't done <span class="QUOTE">"Privoxy"</span> packaging
 471             before for other platform specific issues. Conversely, please add
 472             any notes that you know are important for your platform (or
 473             contact one of the doc maintainers to do this if you can't).</p>
 474           </li>
 475
 476           <li>
 477             <p>Packagers should do a <span class="QUOTE">"clean"</span>
 478             install of their package after building it. So any previous
 479             installs should be removed first to ensure the integrity of the
 480             newly built package. Then run the package for a while to make
 481             sure there are no obvious problems, before uploading.</p>
 482           </li>
 483         </ul>
 484       </div>
 485
 486       <div class="SECT3">
 487         <h3 class="SECT3"><a name="NEWRELEASE-TARBALL" id=
 488         "NEWRELEASE-TARBALL">6.3.2. Source Tarball</a></h3>
 489
 490         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that
 491         you have freshly exported the right version into an empty
 492         directory</i></span>. (See "Building and releasing packages" above).
 493         Then run:</p>
 494
 495         <table border="0" bgcolor="#E0E0E0" width="100%">
 496           <tr>
 497             <td>
 498               <pre class="PROGRAMLISTING">
 499   cd current
 500   autoheader &amp;&amp; autoconf &amp;&amp; ./configure
 501 </pre>
 502             </td>
 503           </tr>
 504         </table>
 505
 506         <p>Then do:</p>
 507
 508         <table border="0" bgcolor="#E0E0E0" width="100%">
 509           <tr>
 510             <td>
 511               <pre class="PROGRAMLISTING">
 512   make tarball-dist
 513 </pre>
 514             </td>
 515           </tr>
 516         </table>
 517
 518         <p>To upload the package to Sourceforge, simply issue</p>
 519
 520         <table border="0" bgcolor="#E0E0E0" width="100%">
 521           <tr>
 522             <td>
 523               <pre class="PROGRAMLISTING">
 524   make tarball-upload
 525 </pre>
 526             </td>
 527           </tr>
 528         </table>
 529
 530         <p>Go to the displayed URL and release the file publicly on
 531         Sourceforge. For the change log field, use the relevant section of
 532         the <tt class="FILENAME">ChangeLog</tt> file.</p>
 533       </div>
 534
 535       <div class="SECT3">
 536         <h3 class="SECT3"><a name="NEWRELEASE-RPM" id="NEWRELEASE-RPM">6.3.3.
 537         SuSE, Conectiva or Red Hat RPM</a></h3>
 538
 539         <p>In following text, replace <tt class=
 540         "REPLACEABLE"><i>dist</i></tt> with either <span class=
 541         "QUOTE">"rh"</span> for Red Hat or <span class="QUOTE">"suse"</span>
 542         for SuSE.</p>
 543
 544         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that
 545         you have freshly exported the right version into an empty
 546         directory</i></span>. (See "Building and releasing packages"
 547         above).</p>
 548
 549         <p>As the only exception to not changing anything after export from
 550         CVS, now examine the file <tt class=
 551         "FILENAME">privoxy-</tt><tt class="REPLACEABLE"><i>dist</i></tt><tt class="FILENAME">.spec</tt>
 552         and make sure that the version information and the RPM release number
 553         are correct. The RPM release numbers for each version start at one.
 554         Hence it must be reset to one if this is the first RPM for <tt class=
 555         "REPLACEABLE"><i>dist</i></tt> which is built from version X.Y.Z.
 556         Check the <a href=
 557         "https://sourceforge.net/project/showfiles.php?group_id=11118"
 558         target="_top">file list</a> if unsure. Else, it must be set to the
 559         highest already available RPM release number for that version plus
 560         one.</p>
 561
 562         <p>Then run:</p>
 563
 564         <table border="0" bgcolor="#E0E0E0" width="100%">
 565           <tr>
 566             <td>
 567               <pre class="PROGRAMLISTING">
 568   cd current
 569   autoheader &amp;&amp; autoconf &amp;&amp; ./configure
 570 </pre>
 571             </td>
 572           </tr>
 573         </table>
 574
 575         <p>Then do</p>
 576
 577         <table border="0" bgcolor="#E0E0E0" width="100%">
 578           <tr>
 579             <td>
 580               <pre class="PROGRAMLISTING">
 581   make <tt class="REPLACEABLE"><i>dist</i></tt>-dist
 582 </pre>
 583             </td>
 584           </tr>
 585         </table>
 586
 587         <p>To upload the package to Sourceforge, simply issue</p>
 588
 589         <table border="0" bgcolor="#E0E0E0" width="100%">
 590           <tr>
 591             <td>
 592               <pre class="PROGRAMLISTING">
 593   make <tt class="REPLACEABLE"><i>dist</i></tt>-upload <tt class=
 594 "REPLACEABLE"><i>rpm_packagerev</i></tt>
 595 </pre>
 596             </td>
 597           </tr>
 598         </table>
 599
 600         <p>where <tt class="REPLACEABLE"><i>rpm_packagerev</i></tt> is the
 601         RPM release number as determined above. Go to the displayed URL and
 602         release the file publicly on Sourceforge. Use the release notes and
 603         change log from the source tarball package.</p>
 604       </div>
 605
 606       <div class="SECT3">
 607         <h3 class="SECT3"><a name="NEWRELEASE-OS2" id="NEWRELEASE-OS2">6.3.4.
 608         OS/2</a></h3>
 609
 610         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that
 611         you have freshly exported the right version into an empty
 612         directory</i></span>. (See "Building and releasing packages" above).
 613         Then get the OS/2 Setup module:</p>
 614
 615         <table border="0" bgcolor="#E0E0E0" width="100%">
 616           <tr>
 617             <td>
 618               <pre class="PROGRAMLISTING">
 619   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
 620 </pre>
 621             </td>
 622           </tr>
 623         </table>
 624
 625         <p>You will need a mix of development tools. The main compilation
 626         takes place with IBM Visual Age C++. Some ancillary work takes place
 627         with GNU tools, available from various sources like hobbes.nmsu.edu.
 628         Specificially, you will need <tt class="FILENAME">autoheader</tt>,
 629         <tt class="FILENAME">autoconf</tt> and <tt class="FILENAME">sh</tt>
 630         tools. The packaging takes place with WarpIN, available from various
 631         sources, including its home page: <a href=
 632         "http://www.xworkplace.org/" target="_top">xworkplace</a>.</p>
 633
 634         <p>Change directory to the <tt class="FILENAME">os2setup</tt>
 635         directory. Edit the os2build.cmd file to set the final executable
 636         filename. For example,</p>
 637
 638         <table border="0" bgcolor="#E0E0E0" width="100%">
 639           <tr>
 640             <td>
 641               <pre class="PROGRAMLISTING">
 642   installExeName='privoxyos2_setup_X.Y.Z.exe'
 643 </pre>
 644             </td>
 645           </tr>
 646         </table>
 647
 648         <p>Next, edit the <tt class="FILENAME">IJB.wis</tt> file so the
 649         release number matches in the <tt class="FILENAME">PACKAGEID</tt>
 650         section:</p>
 651
 652         <table border="0" bgcolor="#E0E0E0" width="100%">
 653           <tr>
 654             <td>
 655               <pre class="PROGRAMLISTING">
 656   PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
 657 </pre>
 658             </td>
 659           </tr>
 660         </table>
 661
 662         <p>You're now ready to build. Run:</p>
 663
 664         <table border="0" bgcolor="#E0E0E0" width="100%">
 665           <tr>
 666             <td>
 667               <pre class="PROGRAMLISTING">
 668   os2build
 669 </pre>
 670             </td>
 671           </tr>
 672         </table>
 673
 674         <p>You will find the WarpIN-installable executable in the <tt class=
 675         "FILENAME">./files</tt> directory. Upload this anonymously to
 676         <tt class="FILENAME">uploads.sourceforge.net/incoming</tt>, create a
 677         release for it, and you're done. Use the release notes and Change Log
 678         from the source tarball package.</p>
 679       </div>
 680
 681       <div class="SECT3">
 682         <h3 class="SECT3"><a name="NEWRELEASE-SOLARIS" id=
 683         "NEWRELEASE-SOLARIS">6.3.5. Solaris</a></h3>
 684
 685         <p>Login to Sourceforge's compilefarm via ssh:</p>
 686
 687         <table border="0" bgcolor="#E0E0E0" width="100%">
 688           <tr>
 689             <td>
 690               <pre class="PROGRAMLISTING">
 691   ssh cf.sourceforge.net
 692 </pre>
 693             </td>
 694           </tr>
 695         </table>
 696
 697         <p>Choose the right operating system (not the Debian one). When
 698         logged in, <span class="emphasis"><i class="EMPHASIS">make sure that
 699         you have freshly exported the right version into an empty
 700         directory</i></span>. (See "Building and releasing packages" above).
 701         Then run:</p>
 702
 703         <table border="0" bgcolor="#E0E0E0" width="100%">
 704           <tr>
 705             <td>
 706               <pre class="PROGRAMLISTING">
 707   cd current
 708   autoheader &amp;&amp; autoconf &amp;&amp; ./configure
 709 </pre>
 710             </td>
 711           </tr>
 712         </table>
 713
 714         <p>Then run</p>
 715
 716         <table border="0" bgcolor="#E0E0E0" width="100%">
 717           <tr>
 718             <td>
 719               <pre class="PROGRAMLISTING">
 720   gmake solaris-dist
 721 </pre>
 722             </td>
 723           </tr>
 724         </table>
 725
 726         <p>which creates a gzip'ed tar archive. Sadly, you cannot use
 727         <b class="COMMAND">make solaris-upload</b> on the Sourceforge machine
 728         (no ncftpput). You now have to manually upload the archive to
 729         Sourceforge's ftp server and release the file publicly. Use the
 730         release notes and Change Log from the source tarball package.</p>
 731       </div>
 732
 733       <div class="SECT3">
 734         <h3 class="SECT3"><a name="NEWRELEASE-WINDOWS" id=
 735         "NEWRELEASE-WINDOWS">6.3.6. Windows</a></h3>
 736
 737         <p>Use the <a href=
 738         "http://www.fruitbat.org/Cygwin/index.html#cygwincirca" target=
 739         "_top">Cygwin Time Machine</a> to install the last 1.5 version of
 740         Cygwin. Run the following commands from within the Cygwin 1.5 bash
 741         shell.</p>
 742
 743         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that
 744         you have freshly exported the right version into an empty
 745         directory</i></span>. (See "Building and releasing packages" above).
 746         Then get the Windows setup module:</p>
 747
 748         <table border="0" bgcolor="#E0E0E0" width="100%">
 749           <tr>
 750             <td>
 751               <pre class="PROGRAMLISTING">
 752   cvs -z3  -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
 753 </pre>
 754             </td>
 755           </tr>
 756         </table>
 757
 758         <p>Then you can build the package. This is fully automated, and is
 759         controlled by <tt class="FILENAME">winsetup/GNUmakefile</tt>. All you
 760         need to do is:</p>
 761
 762         <table border="0" bgcolor="#E0E0E0" width="100%">
 763           <tr>
 764             <td>
 765               <pre class="PROGRAMLISTING">
 766   cd winsetup
 767   make
 768 </pre>
 769             </td>
 770           </tr>
 771         </table>
 772
 773         <p>Now you can manually rename <tt class=
 774         "FILENAME">privoxy_setup.exe</tt> to <tt class=
 775         "FILENAME">privoxy_setup_X_Y_Z.exe</tt>, and upload it to
 776         SourceForge. When releasing the package on SourceForge, use the
 777         release notes and Change Log from the source tarball package.</p>
 778       </div>
 779
 780       <div class="SECT3">
 781         <h3 class="SECT3"><a name="NEWRELEASE-DEBIAN" id=
 782         "NEWRELEASE-DEBIAN">6.3.7. Debian</a></h3>
 783
 784         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that
 785         you have freshly exported the right version into an empty
 786         directory</i></span>. (See "Building and releasing packages" above).
 787         Then add a log entry to <tt class="FILENAME">debian/changelog</tt>,
 788         if it is not already there, for example by running:</p>
 789
 790         <table border="0" bgcolor="#E0E0E0" width="100%">
 791           <tr>
 792             <td>
 793               <pre class="PROGRAMLISTING">
 794   debchange -v 3.0.26-stable-1 "New upstream version"
 795 </pre>
 796             </td>
 797           </tr>
 798         </table>
 799
 800         <p>Then, run:</p>
 801
 802         <table border="0" bgcolor="#E0E0E0" width="100%">
 803           <tr>
 804             <td>
 805               <pre class="PROGRAMLISTING">
 806   dpkg-buildpackage -rfakeroot -us -uc -b
 807 </pre>
 808             </td>
 809           </tr>
 810         </table>
 811
 812         <p>This will create <tt class=
 813         "FILENAME">../privoxy_3.0.26-stable-1_i386.deb</tt> which can be
 814         uploaded. To upload the package to Sourceforge, simply issue</p>
 815
 816         <table border="0" bgcolor="#E0E0E0" width="100%">
 817           <tr>
 818             <td>
 819               <pre class="PROGRAMLISTING">
 820   make debian-upload
 821 </pre>
 822             </td>
 823           </tr>
 824         </table>
 825       </div>
 826
 827       <div class="SECT3">
 828         <h3 class="SECT3"><a name="NEWRELEASE-MACOSX" id=
 829         "NEWRELEASE-MACOSX">6.3.8. Mac OS X</a></h3>
 830
 831         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that
 832         you have freshly exported the right version into an empty
 833         directory</i></span>. (See "Building and releasing packages"
 834         above).</p>
 835
 836         <p>There are three modules available in the CVS repository for use on
 837         Mac OS X, though technically only two of them generate a release (the
 838         other can be used to install from source).</p>
 839
 840         <div class="SECT4">
 841           <h4 class="SECT4"><a name="OS-X-OSXPACKAGEBUILDER-MODULE" id=
 842           "OS-X-OSXPACKAGEBUILDER-MODULE">6.3.8.1. OSXPackageBuilder
 843           module</a></h4>
 844
 845           <p>The OSXPackageBuilder module generates OS X installer packages
 846           supporting all Macs running OS X 10.4 and above. Obtain it from CVS
 847           as follows into a folder parallel to the exported privoxy
 848           source:</p>
 849
 850           <table border="0" bgcolor="#E0E0E0" width="100%">
 851             <tr>
 852               <td>
 853                 <pre class="PROGRAMLISTING">
 854   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
 855 </pre>
 856               </td>
 857             </tr>
 858           </table>
 859
 860           <p>The module contains complete instructions on its usage in the
 861           file <tt class="FILENAME">OS X Package Builder HOWTO.txt</tt>.</p>
 862
 863           <p>Once the package(s) have been generated, you can then upload
 864           them directly to the Files section of the Sourceforge project in
 865           the Macintosh (OS X) folder. Each new version release of Privoxy
 866           should have a new subfolder created in which to store its files.
 867           Please ensure that the folder contains a readme file that makes it
 868           clear which package is for whichversion of OS X.</p>
 869         </div>
 870
 871         <div class="SECT4">
 872           <h4 class="SECT4"><a name="OS-X-OSXSETUP-MODULE" id=
 873           "OS-X-OSXSETUP-MODULE">6.3.8.2. osxsetup module
 874           (DEPRECATED)</a></h4>
 875
 876           <p><span class="emphasis"><i class="EMPHASIS">This module is
 877           deprecated since the installer it generates places all Privoxy
 878           files in one folder in a non-standard location, and supports only
 879           Intel Macs running OS X 10.6 or higher.</i></span></p>
 880
 881           <p>Check out the module from CVS as follows into a folder parallel
 882           to the exported privoxy source:</p>
 883
 884           <table border="0" bgcolor="#E0E0E0" width="100%">
 885             <tr>
 886               <td>
 887                 <pre class="PROGRAMLISTING">
 888   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
 889 </pre>
 890               </td>
 891             </tr>
 892           </table>
 893
 894           <p>Then run:</p>
 895
 896           <table border="0" bgcolor="#E0E0E0" width="100%">
 897             <tr>
 898               <td>
 899                 <pre class="PROGRAMLISTING">
 900   cd osxsetup
 901   build
 902 </pre>
 903               </td>
 904             </tr>
 905           </table>
 906
 907           <p>This will run <tt class="FILENAME">autoheader</tt>, <tt class=
 908           "FILENAME">autoconf</tt> and <tt class="FILENAME">configure</tt> as
 909           well as <tt class="FILENAME">make</tt>. Finally, it will copy over
 910           the necessary files to the ./osxsetup/files directory for further
 911           processing by <tt class="FILENAME">PackageMaker</tt>.</p>
 912
 913           <p>Bring up PackageMaker with the PrivoxyPackage.pmsp definition
 914           file, modify the package name to match the release, and hit the
 915           "Create package" button. If you specify ./Privoxy.pkg as the output
 916           package name, you can then create the distributable zip file with
 917           the command:</p>
 918
 919           <table border="0" bgcolor="#E0E0E0" width="100%">
 920             <tr>
 921               <td>
 922                 <pre class="PROGRAMLISTING">
 923   zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
 924 </pre>
 925               </td>
 926             </tr>
 927           </table>
 928
 929           <p>You can then upload this file directly to the Files section of
 930           the Sourceforge project in the Macintosh (OS X) folder. Each new
 931           version release of Privoxy should have a new subfolder created in
 932           which to store its files. Please ensure that the folder contains a
 933           readme file that makes it clear which version(s) of OS X the
 934           package supports.</p>
 935         </div>
 936
 937         <div class="SECT4">
 938           <h4 class="SECT4"><a name="OS-X-MACSETUP-MODULE" id=
 939           "OS-X-MACSETUP-MODULE">6.3.8.3. macsetup module</a></h4>
 940
 941           <p>The macsetup module is ideal if you wish to build and install
 942           Privoxy from source on a single machine.</p>
 943
 944           <p>Check out the module from CVS as follows into a folder parallel
 945           to the exported privoxy source:</p>
 946
 947           <table border="0" bgcolor="#E0E0E0" width="100%">
 948             <tr>
 949               <td>
 950                 <pre class="PROGRAMLISTING">
 951   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
 952 </pre>
 953               </td>
 954             </tr>
 955           </table>
 956
 957           <p>The module contains complete instructions on its usage in its
 958           <tt class="FILENAME">README</tt> file. The end result will be the
 959           exported version of Privoxy installed on the build machine.</p>
 960         </div>
 961       </div>
 962
 963       <div class="SECT3">
 964         <h3 class="SECT3"><a name="NEWRELEASE-FREEBSD" id=
 965         "NEWRELEASE-FREEBSD">6.3.9. FreeBSD</a></h3>
 966
 967         <p>Update the www/privoxy port and submit a diff upstream. For
 968         details see the <a href=
 969         "https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/"
 970         target="_top">FreeBSD Porter's Handbook</a>.</p>
 971       </div>
 972     </div>
 973
 974     <div class="SECT2">
 975       <h2 class="SECT2"><a name="RELEASING" id="RELEASING">6.4. Uploading and
 976       Releasing Your Package</a></h2>
 977
 978       <p>After the package is ready, it is time to upload it to SourceForge,
 979       and go through the release steps. The upload is done via FTP:</p>
 980
 981       <ul>
 982         <li>
 983           <p>Upload to: <a href="ftp://upload.sourceforge.net/incoming"
 984           target="_top">ftp://upload.sourceforge.net/incoming</a></p>
 985         </li>
 986
 987         <li>
 988           <p>user: <tt class="LITERAL">anonymous</tt></p>
 989         </li>
 990
 991         <li>
 992           <p>password: <tt class=
 993           "LITERAL">ijbswa-developers@lists.sourceforge.net</tt></p>
 994         </li>
 995       </ul>
 996
 997       <p>Or use the <b class="COMMAND">make</b> targets as described
 998       above.</p>
 999
1000       <p>Once this done go to <a href=
1001       "https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
1002       target=
1003       "_top">https://sourceforge.net/project/admin/editpackages.php?group_id=11118</a>,
1004       making sure you are logged in. Find your target platform in the second
1005       column, and click <tt class="LITERAL">Add Release</tt>. You will then
1006       need to create a new release for your package, using the format of
1007       <tt class="LITERAL">$VERSION ($CODE_STATUS)</tt>, e.g. <span class=
1008       "emphasis"><i class="EMPHASIS">3.0.26 (beta)</i></span>.</p>
1009
1010       <p>Now just follow the prompts. Be sure to add any appropriate Release
1011       notes. You should see your freshly uploaded packages in <span class=
1012       "QUOTE">"Step 2. Add Files To This Release"</span>. Check the
1013       appropriate box(es). Remember at each step to hit the <span class=
1014       "QUOTE">"Refresh/Submit"</span> buttons! You should now see your
1015       file(s) listed in Step 3. Fill out the forms with the appropriate
1016       information for your platform, being sure to hit <span class=
1017       "QUOTE">"Update"</span> for each file. If anyone is monitoring your
1018       platform, check the <span class="QUOTE">"email"</span> box at the very
1019       bottom to notify them of the new package. This should do it!</p>
1020
1021       <p>If you have made errors, or need to make changes, you can go through
1022       essentially the same steps, but select <tt class="LITERAL">Edit
1023       Release</tt>, instead of <tt class="LITERAL">Add Release</tt>.</p>
1024     </div>
1025
1026     <div class="SECT2">
1027       <h2 class="SECT2"><a name="AFTERRELEASE" id="AFTERRELEASE">6.5. After
1028       the Release</a></h2>
1029
1030       <p>When all (or: most of the) packages have been uploaded and made
1031       available, send an email to the <a href=
1032       "mailto:privoxy-announce@lists.privoxy.org" target="_top">announce
1033       mailing list</a>, Subject: "Version X.Y.Z available for download". Be
1034       sure to include the <a href=
1035       "https://sourceforge.net/project/showfiles.php?group_id=11118" target=
1036       "_top">download location</a>, the release notes and the Changelog.
1037       Also, post an updated News item on the project page Sourceforge, and
1038       update the Home page and docs linked from the Home page (see below).
1039       Other news sites and release oriented sites, such as Freshmeat, should
1040       also be notified.</p>
1041     </div>
1042   </div>
1043
1044   <div class="NAVFOOTER">
1045     <hr align="left" width="100%">
1046
1047     <table summary="Footer navigation table" width="100%" border="0"
1048     cellpadding="0" cellspacing="0">
1049       <tr>
1050         <td width="33%" align="left" valign="top"><a href="testing.html"
1051         accesskey="P">Prev</a></td>
1052
1053         <td width="34%" align="center" valign="top"><a href="index.html"
1054         accesskey="H">Home</a></td>
1055
1056         <td width="33%" align="right" valign="top"><a href=
1057         "webserver-update.html" accesskey="N">Next</a></td>
1058       </tr>
1059
1060       <tr>
1061         <td width="33%" align="left" valign="top">Testing Guidelines</td>
1062
1063         <td width="34%" align="center" valign="top">&nbsp;</td>
1064
1065         <td width="33%" align="right" valign="top">Update the Webserver</td>
1066       </tr>
1067     </table>
1068   </div>
1069 </body>
1070 </html>