1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
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">
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">
22 <th colspan="3" align="center">Privoxy Developer Manual</th>
26 <td width="10%" align="left" valign="bottom"><a href="testing.html"
27 accesskey="P">Prev</a></td>
29 <td width="80%" align="center" valign="bottom"></td>
31 <td width="10%" align="right" valign="bottom"><a href=
32 "webserver-update.html" accesskey="N">Next</a></td>
35 <hr align="left" width="100%">
39 <h1 class="SECT1"><a name="NEWRELEASE" id="NEWRELEASE">6. Releasing a New
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>
48 <p>So when releasing a new version, please adhere exactly to the
49 procedure outlined in this chapter.</p>
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,
57 <h2 class="SECT2"><a name="VERSIONNUMBERS" id="VERSIONNUMBERS">6.1.
58 Version numbers</a></h2>
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),
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>
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
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>
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 -> 0.0.0 ->
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 -> 3.0.1 -> 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>
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>
143 <h2 class="SECT2"><a name="BEFORERELEASE" id="BEFORERELEASE">6.2.
144 Before the Release: Freeze</a></h2>
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>
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>
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>
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>
169 <table border="0" bgcolor="#E0E0E0" width="90%">
172 <pre class="PROGRAMLISTING">
173 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
179 <p>Then change the version info in doc/webserver/actions/index.php,
180 line: '$required_actions_file_version = "A.B";'</p>
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>
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>
210 <p>All developers should look at the <tt class=
211 "FILENAME">ChangeLog</tt> and make sure noteworthy changes are
216 <p><span class="emphasis"><i class="EMPHASIS">Commit all files that
217 were changed in the above steps!</i></span></p>
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>
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>
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>
246 <h2 class="SECT2"><a name="THERELEASE" id="THERELEASE">6.3. Building
247 and Releasing the Packages</a></h2>
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
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>
259 <table border="0" bgcolor="#E0E0E0" width="100%">
262 <pre class="PROGRAMLISTING">
263 mkdir dist # delete or choose different name if it already exists
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
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
278 <div class="WARNING">
279 <table class="WARNING" border="1" width="100%">
281 <td align="center"><b>Warning</b></td>
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>
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>
302 <h3 class="SECT3"><a name="PACK-GUIDELINES" id=
303 "PACK-GUIDELINES">6.3.1. Note on Privoxy Packaging</a></h3>
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>
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>
319 <p>Please include up to date documentation. At a bare
325 <td><tt class="FILENAME">LICENSE</tt> (top-level
334 <td><tt class="FILENAME">README</tt> (top-level
343 <td><tt class="FILENAME">AUTHORS</tt> (top-level
352 <td><tt class="FILENAME">man page</tt> (top-level
353 directory, Unix-like platforms only)</td>
361 <td><tt class="FILENAME">The User Manual</tt>
362 (doc/webserver/user-manual/)</td>
370 <td><tt class="FILENAME">FAQ</tt> (doc/webserver/faq/)</td>
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>
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>
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>
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>
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>
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>
436 <h3 class="SECT3"><a name="NEWRELEASE-TARBALL" id=
437 "NEWRELEASE-TARBALL">6.3.2. Source Tarball</a></h3>
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).
444 <table border="0" bgcolor="#E0E0E0" width="100%">
447 <pre class="PROGRAMLISTING">
449 autoheader && autoconf && ./configure
457 <table border="0" bgcolor="#E0E0E0" width="100%">
460 <pre class="PROGRAMLISTING">
467 <p>To upload the package to Sourceforge, simply issue</p>
469 <table border="0" bgcolor="#E0E0E0" width="100%">
472 <pre class="PROGRAMLISTING">
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>
485 <h3 class="SECT3"><a name="NEWRELEASE-RPM" id="NEWRELEASE-RPM">6.3.3.
486 SuSE, Conectiva or Red Hat RPM</a></h3>
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>
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"
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.
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>
512 <table border="0" bgcolor="#E0E0E0" width="100%">
515 <pre class="PROGRAMLISTING">
517 autoheader && autoconf && ./configure
525 <table border="0" bgcolor="#E0E0E0" width="100%">
528 <pre class="PROGRAMLISTING">
529 make <tt class="REPLACEABLE"><i>dist</i></tt>-dist
535 <p>To upload the package to Sourceforge, simply issue</p>
537 <table border="0" bgcolor="#E0E0E0" width="100%">
540 <pre class="PROGRAMLISTING">
541 make <tt class="REPLACEABLE"><i>dist</i></tt>-upload <tt class=
542 "REPLACEABLE"><i>rpm_packagerev</i></tt>
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>
555 <h3 class="SECT3"><a name="NEWRELEASE-OS2" id="NEWRELEASE-OS2">6.3.4.
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>
563 <table border="0" bgcolor="#E0E0E0" width="100%">
566 <pre class="PROGRAMLISTING">
567 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
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>
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>
586 <table border="0" bgcolor="#E0E0E0" width="100%">
589 <pre class="PROGRAMLISTING">
590 installExeName='privoxyos2_setup_X.Y.Z.exe'
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>
600 <table border="0" bgcolor="#E0E0E0" width="100%">
603 <pre class="PROGRAMLISTING">
604 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
610 <p>You're now ready to build. Run:</p>
612 <table border="0" bgcolor="#E0E0E0" width="100%">
615 <pre class="PROGRAMLISTING">
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>
630 <h3 class="SECT3"><a name="NEWRELEASE-SOLARIS" id=
631 "NEWRELEASE-SOLARIS">6.3.5. Solaris</a></h3>
633 <p>Login to Sourceforge's compilefarm via ssh:</p>
635 <table border="0" bgcolor="#E0E0E0" width="100%">
638 <pre class="PROGRAMLISTING">
639 ssh cf.sourceforge.net
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).
651 <table border="0" bgcolor="#E0E0E0" width="100%">
654 <pre class="PROGRAMLISTING">
656 autoheader && autoconf && ./configure
664 <table border="0" bgcolor="#E0E0E0" width="100%">
667 <pre class="PROGRAMLISTING">
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>
682 <h3 class="SECT3"><a name="NEWRELEASE-WINDOWS" id=
683 "NEWRELEASE-WINDOWS">6.3.6. Windows</a></h3>
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
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>
696 <table border="0" bgcolor="#E0E0E0" width="100%">
699 <pre class="PROGRAMLISTING">
700 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
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
710 <table border="0" bgcolor="#E0E0E0" width="100%">
713 <pre class="PROGRAMLISTING">
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>
729 <h3 class="SECT3"><a name="NEWRELEASE-DEBIAN" id=
730 "NEWRELEASE-DEBIAN">6.3.7. Debian</a></h3>
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>
738 <table border="0" bgcolor="#E0E0E0" width="100%">
741 <pre class="PROGRAMLISTING">
742 debchange -v 3.0.24-stable-1 "New upstream version"
750 <table border="0" bgcolor="#E0E0E0" width="100%">
753 <pre class="PROGRAMLISTING">
754 dpkg-buildpackage -rfakeroot -us -uc -b
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>
764 <table border="0" bgcolor="#E0E0E0" width="100%">
767 <pre class="PROGRAMLISTING">
776 <h3 class="SECT3"><a name="NEWRELEASE-MACOSX" id=
777 "NEWRELEASE-MACOSX">6.3.8. Mac OS X</a></h3>
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"
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>
789 <h4 class="SECT4"><a name="OS-X-OSXPACKAGEBUILDER-MODULE" id=
790 "OS-X-OSXPACKAGEBUILDER-MODULE">6.3.8.1. OSXPackageBuilder
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
798 <table border="0" bgcolor="#E0E0E0" width="100%">
801 <pre class="PROGRAMLISTING">
802 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
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>
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>
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>
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>
829 <p>Check out the module from CVS as follows into a folder parallel
830 to the exported privoxy source:</p>
832 <table border="0" bgcolor="#E0E0E0" width="100%">
835 <pre class="PROGRAMLISTING">
836 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
844 <table border="0" bgcolor="#E0E0E0" width="100%">
847 <pre class="PROGRAMLISTING">
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>
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
867 <table border="0" bgcolor="#E0E0E0" width="100%">
870 <pre class="PROGRAMLISTING">
871 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
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>
886 <h4 class="SECT4"><a name="OS-X-MACSETUP-MODULE" id=
887 "OS-X-MACSETUP-MODULE">6.3.8.3. macsetup module</a></h4>
889 <p>The macsetup module is ideal if you wish to build and install
890 Privoxy from source on a single machine.</p>
892 <p>Check out the module from CVS as follows into a folder parallel
893 to the exported privoxy source:</p>
895 <table border="0" bgcolor="#E0E0E0" width="100%">
898 <pre class="PROGRAMLISTING">
899 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
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>
912 <h3 class="SECT3"><a name="NEWRELEASE-FREEBSD" id=
913 "NEWRELEASE-FREEBSD">6.3.9. FreeBSD</a></h3>
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>
923 <h2 class="SECT2"><a name="RELEASING" id="RELEASING">6.4. Uploading and
924 Releasing Your Package</a></h2>
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>
931 <p>Upload to: <a href="ftp://upload.sourceforge.net/incoming"
932 target="_top">ftp://upload.sourceforge.net/incoming</a></p>
936 <p>user: <tt class="LITERAL">anonymous</tt></p>
940 <p>password: <tt class=
941 "LITERAL">ijbswa-developers@lists.sourceforge.net</tt></p>
945 <p>Or use the <b class="COMMAND">make</b> targets as described
948 <p>Once this done go to <a href=
949 "https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
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>
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>
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>
975 <h2 class="SECT2"><a name="AFTERRELEASE" id="AFTERRELEASE">6.5. After
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>
992 <div class="NAVFOOTER">
993 <hr align="left" width="100%">
995 <table summary="Footer navigation table" width="100%" border="0"
996 cellpadding="0" cellspacing="0">
998 <td width="33%" align="left" valign="top"><a href="testing.html"
999 accesskey="P">Prev</a></td>
1001 <td width="34%" align="center" valign="top"><a href="index.html"
1002 accesskey="H">Home</a></td>
1004 <td width="33%" align="right" valign="top"><a href=
1005 "webserver-update.html" accesskey="N">Next</a></td>
1009 <td width="33%" align="left" valign="top">Testing Guidelines</td>
1011 <td width="34%" align="center" valign="top"> </td>
1013 <td width="33%" align="right" valign="top">Update the Webserver</td>