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