doc/webserver/developer-manual/newrelease.html

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