+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Releasing a New Version</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.64
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
HREF="webserver-update.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="testing.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="webserver-update.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
procedure outlined in this chapter.
</P
><P
-> The following programs are required to follow this process:
- <TT
+> The following programs are required to follow this process:
+ <TT
CLASS="FILENAME"
>ncftpput</TT
> (ncftp), <TT
>6.1. Version numbers</A
></H2
><P
-> First you need to determine which version number the release will have.
+> First you need to determine which version number the release will have.
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> version numbers consist of three numbers,
- separated by dots, like in X.Y.Z, where:
- <P
+ separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
+ </P
+><P
></P
><UL
><LI
><P
> X, the version major, is rarely ever changed. It is increased by one if
turning a development branch into stable substantially changes the functionality,
- user interface or configuration syntax. Majors 1 and 2 were
+ user interface or configuration syntax. Majors 1 and 2 were
<SPAN
CLASS="APPLICATION"
>Junkbuster</SPAN
></LI
><LI
><P
-> Y, the version minor, represents the branch within the major version.
+>
+ Y, the version minor, represents the branch within the major version.
At any point in time, there are two branches being maintained:
The stable branch, with an even minor, say, 2N, in which no functionality is
- being added and only bugfixes are made, and 2N+1, the development branch, in
+ being added and only bug-fixes are made, and 2N+1, the development branch, in
which the further development of <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
place.
This enables us to turn the code upside down and inside out, while at the same time
providing and maintaining a stable version.
- The minor is reset to zero (and one) when the major is inrcemented. When a development
+ The minor is reset to zero (and one) when the major is incremented. When a development
branch has matured to the point where it can be turned into stable, the old stable branch
2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
new stable branch 2N+2, and a new development branch 2N+3 is opened.
><LI
><P
> Z, the point or sub version, represents a release of the software within a branch.
- It is therefore incremented immediately before each code freeze.
- In development branches, only the even point versions correspond to actual releases,
- while the odd ones denote the evolving state of the sources on CVS in between.
- It follows that Z is odd on CVS in development branches most of the time. There, it gets
- increased to an even number immediately before a code freeze, and is increased to an odd
- number again immediately thereafter.
- This ensures that builds from CVS snapshots are easily distinguished from released versions.
+ It is therefore incremented immediately after each software release.
+
The point version is reset to zero when the minor changes.
</P
+><P
+> Stable branches work a little differently, since there should be
+ little to no development happening in such branches. Remember,
+ only bugfixes, which presumably should have had some testing
+ before being committed. Stable branches will then have their
+ version reported as <TT
+CLASS="LITERAL"
+>0.0.0</TT
+>, during that period
+ between releases when changes are being added. This is to denote
+ that this code is <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>not for release</I
+></SPAN
+>. Then
+ as the release nears, the version is bumped according: e.g.
+ <TT
+CLASS="LITERAL"
+>3.0.1 -> 0.0.0 -> 3.0.2</TT
+>.
+ </P
></LI
></UL
->
+><P
+> In summary, the main Git trunk is the development branch where new
+ features are being worked on for the next stable series. This should
+ almost always be where the most activity takes place. There is always at
+ least one stable branch from the trunk, e.g now it is
+ <TT
+CLASS="LITERAL"
+>3.0</TT
+>, which is only used to release stable versions.
+ Once the initial *.0 release of the stable branch has been done, then as a
+ rule, only bugfixes that have had prior testing should be committed to
+ the stable branch. Once there are enough bugfixes to justify a new
+ release, the version of this branch is again incremented Example: 3.0.0
+ -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
+ branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
+ taking place. If any questions, please post to the devel list
+ <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>before</I
+></SPAN
+> committing to a stable branch!
+ </P
+><P
+> Developers should remember too that if they commit a bugfix to the stable
+ branch, this will more than likely require a separate submission to the
+ main trunk, since these are separate development trees within Git. If you
+ are working on both, then this would require at least two separate check
+ outs (i.e main trunk, <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>and</I
+></SPAN
+> the stable release branch,
+ which is <TT
+CLASS="LITERAL"
+>v_3_0_branch</TT
+> at the moment).
</P
></DIV
><DIV
>6.2. Before the Release: Freeze</A
></H2
><P
-> The following <I
+> The following <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>must be done by one of the
developers</I
+></SPAN
> prior to each new release.
</P
><P
-> <P
></P
><UL
><LI
> in case
they have pending changes/fixes in their pipelines. Announce the
freeze so that nobody will interfere with last minute changes.
- </P
+ </P
></LI
><LI
><P
-> Increment the version number (point from odd to even in development
- branches!) in <TT
-CLASS="FILENAME"
->configure.in</TT
->.
+> Update the code status (CODE_STATUS="xxx") in configure.in to one of
+ "alpha", "beta" or "stable".
</P
></LI
><LI
><P
-> If <TT
-CLASS="FILENAME"
->default.action</TT
-> has changed since last
- release (i.e. software release or standalone actions file release),
- bump up its version info to A.B in this line:
+> Rebuild configure and GNUMakefile to make sure the updated values are being used.
</P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="PROGRAMLISTING"
+>$ autoheader && autoconf # rebuild configure
+$ ./configure # rebuild GNUmakefile</PRE
+></TD
+></TR
+></TABLE
+></LI
+><LI
><P
->
- <TABLE
+> <B
+CLASS="COMMAND"
+>make dok-release</B
+> to update the sgml documentation source files.
+ </P
+></LI
+><LI
+><P
+> If action file processing has changed and is not backward-compatible,
+ make sure the "for-privoxy-version=x.y.z" minimum version number in
+ default.action.master has been updated:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}</PRE
+>{{settings}}
+#############################################################################
+#MASTER# COMMENT: The minimum Privoxy version:
+for-privoxy-version=3.0.11</PRE
></TD
></TR
></TABLE
+></LI
+><LI
+><P
+> All documentation should be rebuild after the code status has been changed.
+ Finished docs should be then be committed to Git (for those
+ without the ability to build these). Some docs may require
+ rather obscure processing tools. <TT
+CLASS="FILENAME"
+>config</TT
+>,
+ the man page (and the html version of the man page)
+ fall in this category. README, the man page, AUTHORS, and config
+ should all also be committed to Git for other packagers. The
+ formal docs should be uploaded to the webserver. See the section
+ <A
+HREF="webserver-update.html"
+TARGET="_top"
+>"Updating the webserver"</A
>
+ in this manual for details.
</P
+></LI
+><LI
><P
->
- Then change the version info in doc/webserver/actions/index.php,
- line: '$required_actions_file_version = "A.B";'
+> The <I
+CLASS="CITETITLE"
+>User Manual</I
+> is also used for context
+ sensitive help for the CGI editor. This is version sensitive, so that
+ the user will get appropriate help for his/her release. So with
+ each release a fresh version should be uploaded to the webserver
+ (this is in addition to the main <I
+CLASS="CITETITLE"
+>User Manual</I
+>
+ link from the main page since we need to keep manuals for various
+ versions available). The CGI pages will link to something like
+ <TT
+CLASS="LITERAL"
+>http://privoxy.org/$(VERSION)/user-manual/</TT
+>. This
+ will need to be updated for each new release. There is no Makefile
+ target for this at this time!!! It needs to be done manually.
</P
></LI
><LI
><P
-> If the HTML documentation is not in sync with the SGML sources
- you need to regenerate and upload it to the webserver. (If in
- doubt, just do it.) See the Section "Updating the webserver" in
- this manual for details.
+> All developers should look at the <TT
+CLASS="FILENAME"
+>ChangeLog</TT
+> and
+ make sure noteworthy changes are referenced.
</P
></LI
><LI
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>Commit all files that were changed in the above steps!</I
+></SPAN
>
</P
></LI
><LI
><P
-> Tag all files in CVS with the version number with
+> Tag all files in Git with the version number with
<SPAN
CLASS="QUOTE"
>"<B
<TT
CLASS="FILENAME"
>.</TT
-> (i.e. dot).
+> (i.e. dot).
</P
></LI
></UL
->
- </P
></DIV
><DIV
CLASS="SECT2"
GPL reasons the first package to be released is always the source tarball.
</P
><P
-> For <I
+> For <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> types of packages, including the source tarball,
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>you must make sure that you build from clean sources by exporting
- the right version from CVS into an empty directory:</I
->.
+ the right version from Git into an empty directory</I
+></SPAN
+> (just press return when
+ asked for a password):
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
CLASS="PROGRAMLISTING"
> mkdir dist # delete or choose different name if it already exists
cd dist
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</PRE
+ cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
+ cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</PRE
></TD
></TR
></TABLE
->
- </P
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>Do NOT change</I
+></SPAN
> a single bit, including, but not limited to
- version information after export from CVS. This is to make sure that
+ version information after export from Git. This is to make sure that
all release packages, and with them, all future bug reports, are based
on exactly the same code.
</P
+><DIV
+CLASS="WARNING"
+><P
+></P
+><TABLE
+CLASS="WARNING"
+BORDER="1"
+WIDTH="100%"
+><TR
+><TD
+ALIGN="CENTER"
+><B
+>Warning</B
+></TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+><P
+> Every significant release of Privoxy has included at least one
+ package that either had incorrect versions of files, missing files,
+ or incidental leftovers from a previous build process that gave
+ unknown numbers of users headaches to try to figure out what was
+ wrong. PLEASE, make sure you are using pristene sources, and are
+ following the prescribed process!
+ </P
+></TD
+></TR
+></TABLE
+></DIV
><P
> Please find additional instructions for the source tarball and the
- individual platform dependent binary packages below. And details
+ individual platform dependent binary packages below. And details
on the Sourceforge release process below that.
</P
><DIV
>6.3.1. Note on Privoxy Packaging</A
></H3
><P
-> Please keep these general guidelines in mind when putting together
- your package. These apply to <I
+> Please keep these general guidelines in mind when putting together
+ your package. These apply to <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> platforms!
</P
><P
-> <P
></P
><UL
><LI
> <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>requires</I
+></SPAN
>
write access to: all <TT
CLASS="FILENAME"
>*.action</TT
-> files, all
+> files, all
logfiles, and the <TT
CLASS="FILENAME"
>trust</TT
-> file. You will
+> file. You will
need to determine the best way to do this for your platform.
</P
></LI
> <TT
CLASS="FILENAME"
>LICENSE</TT
-> (toplevel directory)
+> (top-level directory)
</TD
></TR
></TBODY
> <TT
CLASS="FILENAME"
>README</TT
-> (toplevel directory)
+> (top-level directory)
</TD
></TR
></TBODY
> <TT
CLASS="FILENAME"
>AUTHORS</TT
-> (toplevel directory)
+> (top-level directory)
</TD
></TR
></TBODY
> <TT
CLASS="FILENAME"
>man page</TT
-> (toplevel directory, Unix-like
+> (top-level directory, Unix-like
platforms only)
</TD
></TR
CLASS="FILENAME"
>Developer Manual</TT
>
- (doc/webserver/devel-manual) and <TT
+ (doc/webserver/developer-manual) and <TT
CLASS="FILENAME"
>ChangeLog</TT
>
- (toplevel directory). <TT
+ (top-level directory). <TT
CLASS="FILENAME"
>FAQ</TT
> and the manuals are
</P
><P
> The documentation has been designed such that the manuals are linked
- to each other from parallel directories, and should be packaged
+ to each other from parallel directories, and should be packaged
that way. <TT
CLASS="FILENAME"
+>privoxy-index.html</TT
+> can also be
+ included and can serve as a focal point for docs and other links of
+ interest (and possibly renamed to <TT
+CLASS="FILENAME"
>index.html</TT
-> can also be included and
- can serve as a focal point for docs and other links of interest.
- This should be one level up from the manuals. There are two
+>).
+ This should be one level up from the manuals. There is a link also
+ on this page to an HTMLized version of the man page. To avoid 404 for
+ this, it is in Git as
+ <TT
+CLASS="FILENAME"
+>doc/webserver/man-page/privoxy-man-page.html</TT
+>,
+ and should be included along with the manuals. There is also a
css stylesheets that can be included for better presentation:
<TT
CLASS="FILENAME"
>p_doc.css</TT
-> and <TT
-CLASS="FILENAME"
->p_web.css</TT
->.
- These should be in the same directory with
- <TT
+>. This should be in the same directory
+ with <TT
CLASS="FILENAME"
->index.html</TT
->, (i.e. one level up from the manual
- directories).
+>privoxy-index.html</TT
+>, (i.e. one level up from
+ the manual directories).
</P
></LI
><LI
> <TT
CLASS="FILENAME"
>user.action</TT
-> is designed for local preferences.
- Make sure this does not get overwritten!
+> and <TT
+CLASS="FILENAME"
+>user.filter</TT
+>
+ are designed for local preferences. Make sure these do not get overwritten!
+ <TT
+CLASS="FILENAME"
+>config</TT
+> should not be overwritten either. This
+ has especially important configuration data in it.
+ <TT
+CLASS="FILENAME"
+>trust</TT
+> should be left in tact as well.
</P
></LI
><LI
><P
-> Other configuration files should be installed as the new defaults,
- but all previously installed configuration files should be preserved
- as backups. This is just good manners :-)
+> Other configuration files (<TT
+CLASS="FILENAME"
+>default.action</TT
+> and
+ <TT
+CLASS="FILENAME"
+>default.filter</TT
+>) should be installed as the new
+ defaults, but all previously installed configuration files should be
+ preserved as backups. This is just good manners :-) These files are
+ likely to change between releases and contain important new features
+ and bug fixes.
</P
></LI
><LI
><P
-> Please check platform specific notes in this doc, if you haven't
+> Please check platform specific notes in this doc, if you haven't
done <SPAN
CLASS="QUOTE"
>"Privoxy"</SPAN
-> packaging before for other platform
- specific issues. Conversely, please add any notes that you know
- are important for your platform (or contact one of the doc
+> packaging before for other platform
+ specific issues. Conversely, please add any notes that you know
+ are important for your platform (or contact one of the doc
maintainers to do this if you can't).
</P
></LI
-></UL
->
+><LI
+><P
+> Packagers should do a <SPAN
+CLASS="QUOTE"
+>"clean"</SPAN
+> install of their
+ package after building it. So any previous installs should be
+ removed first to ensure the integrity of the newly built package.
+ Then run the package for a while to make sure there are no
+ obvious problems, before uploading.
</P
+></LI
+></UL
></DIV
><DIV
CLASS="SECT3"
>6.3.2. Source Tarball</A
></H3
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then run:
- </P
-><P
-> <TABLE
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
-><P
-> Then do:
- </P
><P
-> <TABLE
+> Then do:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
-><P
-> To upload the package to Sourceforge, simply issue
- </P
><P
-> <TABLE
+> To upload the package to Sourceforge, simply issue
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
><P
-> Go to the displayed URL and release the file publicly on Sourceforge.
+> Go to the displayed URL and release the file publicly on Sourceforge.
For the change log field, use the relevant section of the
<TT
CLASS="FILENAME"
CLASS="QUOTE"
>"suse"</SPAN
> for SuSE.
- </P
+ </P
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
- packages" above).
- </P
+ packages" above).
+ </P
><P
-> As the only exception to not changing anything after export from CVS,
+> As the only exception to not changing anything after export from Git,
now examine the file <TT
CLASS="FILENAME"
>privoxy-</TT
> which is built from version
X.Y.Z. Check the
<A
-HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
+HREF="https://sourceforge.net/project/showfiles.php?group_id=11118"
TARGET="_top"
>file
list</A
> if unsure. Else, it must be set to the highest already available RPM
release number for that version plus one.
- </P
+ </P
><P
> Then run:
- </P
-><P
-> <TABLE
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
><P
-> Then do
- </P
-><P
-> <TABLE
+> Then do
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
><P
-> To upload the package to Sourceforge, simply issue
- </P
-><P
-> <TABLE
+> To upload the package to Sourceforge, simply issue
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
><P
> where <TT
CLASS="REPLACEABLE"
></TT
> is the
RPM release number as determined above.
- Go to the displayed URL and release the file publicly on Sourceforge.
+ Go to the displayed URL and release the file publicly on Sourceforge.
Use the release notes and change log from the source tarball package.
</P
></DIV
>6.3.4. OS/2</A
></H3
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then get the OS/2 Setup module:
- </P
-><P
-> <TABLE
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
+> cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
></TD
></TR
></TABLE
->
- </P
><P
-> You will need a mix of development tools.
- The main compilation takes place with IBM Visual Age C++.
- Some ancillary work takes place with GNU tools, available from
- various sources like hobbes.nmsu.edu.
- Specificially, you will need <TT
+> You will need a mix of development tools.
+ The main compilation takes place with IBM Visual Age C++.
+ Some ancillary work takes place with GNU tools, available from
+ various sources like hobbes.nmsu.edu.
+ Specificially, you will need <TT
CLASS="FILENAME"
>autoheader</TT
>,
- <TT
+ <TT
CLASS="FILENAME"
>autoconf</TT
> and <TT
CLASS="FILENAME"
>sh</TT
> tools.
- The packaging takes place with WarpIN, available from various sources, including
- its home page: <A
+ The packaging takes place with WarpIN, available from various sources, including
HREF="http://www.xworkplace.org/"
TARGET="_top"
>xworkplace</A
>.
- </P
+ </P
><P
-> Change directory to the <TT
+> Change directory to the <TT
CLASS="FILENAME"
>os2setup</TT
> directory.
- Edit the os2build.cmd file to set the final executable filename.
- For example,
- </P
-><P
-> <TABLE
+ Edit the os2build.cmd file to set the final executable filename.
+ For example,
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
><P
-> Next, edit the <TT
+> Next, edit the <TT
CLASS="FILENAME"
>IJB.wis</TT
> file so the release number matches
- in the <TT
+ in the <TT
CLASS="FILENAME"
>PACKAGEID</TT
> section:
- </P
-><P
-> <TABLE
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
-><P
-> You're now ready to build. Run:
- </P
><P
-> <TABLE
+> You're now ready to build. Run:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
><P
> You will find the WarpIN-installable executable in the
<TT
>, create a release
for it, and you're done. Use the release notes and Change Log from the
source tarball package.
- </P
+ </P
></DIV
><DIV
CLASS="SECT3"
>6.3.5. Solaris</A
></H3
><P
-> Login to Sourceforge's compilefarm via ssh:
- </P
-><P
-> <TABLE
+> Login to Sourceforge's compilefarm via ssh:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
><P
-> Choose the right operating system (not the Debian one).
- When logged in, <I
+> Choose the right operating system (not the Debian one).
+ When logged in, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then run:
- </P
-><P
-> <TABLE
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
><P
-> Then run
- </P
-><P
-> <TABLE
+> Then run
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
->
- </P
><P
-> which creates a gzip'ed tar archive. Sadly, you cannot use <B
+> which creates a gzip'ed tar archive. Sadly, you cannot use <B
CLASS="COMMAND"
>make
- solaris-upload</B
+ solaris-upload</B
> on the Sourceforge machine (no ncftpput). You now have
- to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
+ to manually upload the archive to Sourceforge's ftp server and release
+ the file publicly. Use the release notes and Change Log from the
source tarball package.
- </P
+ </P
></DIV
><DIV
CLASS="SECT3"
>6.3.6. Windows</A
></H3
><P
-> You should ensure you have the latest version of Cygwin (from
- <A
-HREF="http://www.cygwin.com/"
-TARGET="_top"
->http://www.cygwin.com/</A
->).
- Run the following commands from within a Cygwin bash shell.
+> Note that the docbook generated files might need some hand editing,
+ so the Windows build makefile does not rebuild the docs.
</P
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
- packages" above). Then get the Windows setup module:
- </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="PROGRAMLISTING"
-> cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup</PRE
-></TD
-></TR
-></TABLE
->
+ packages" above).
+
</P
><P
> Then you can build the package. This is fully automated, and is
controlled by <TT
CLASS="FILENAME"
->winsetup/GNUmakefile</TT
+>windows/GNUmakefile</TT
>.
All you need to do is:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> cd winsetup
- make</PRE
+> cd windows
+ make</PRE
></TD
></TR
></TABLE
->
- </P
><P
> Now you can manually rename <TT
CLASS="FILENAME"
> to
<TT
CLASS="FILENAME"
->privoxy_setup_X_Y_Z.exe</TT
->, and upload it to
- SourceForge. When releasing the package on SourceForge, use the release notes
- and Change Log from the source tarball package.
+>privoxy_setup_X.Y.Z.exe</TT
+>, and the <TT
+CLASS="FILENAME"
+>build</TT
+>
+ directory to <TT
+CLASS="FILENAME"
+>privoxy_X.Y.Z</TT
+>.
+ Create a .zip file of the newly renamed <TT
+CLASS="FILENAME"
+>privoxy_X.Y.Z</TT
+> directory,
+ GPG sign the installer and zip file,
</P
-></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
-NAME="NEWRELEASE-DEBIAN"
->6.3.7. Debian</A
-></H3
-><P
-> First, <I
-CLASS="EMPHASIS"
->make sure that you have freshly exported the right
- version into an empty directory</I
->. (See "Building and releasing
- packages" above). Then, run:
- </P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> cd current
- autoheader && autoconf && ./configure</PRE
+> $ gpg --armor --detach --sign <TT
+CLASS="FILENAME"
+>privoxy_setup_X.Y.Z.exe</TT
+>
+ $ gpg --armor --detach --sign <TT
+CLASS="FILENAME"
+>privoxy_X.Y.Z.zip</TT
+></PRE
></TD
></TR
></TABLE
->
- </P
><P
-> Then do FIXME.
- </P
+> and upload the files to SourceForge.
+ </P
+><P
+> When releasing the package on SourceForge, use the release notes
+ and Change Log from the source tarball package.
+ </P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-MACOSX"
->6.3.8. Mac OSX</A
+NAME="NEWRELEASE-DEBIAN"
+>6.3.7. Debian</A
></H3
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
->make sure that you have freshly exported the right
- version into an empty directory</I
->. (See "Building and releasing
- packages" above). Then get the Mac OSX setup module:
- </P
-><P
-> <TABLE
+>make sure that you have freshly exported the
+ right version into an empty directory</I
+></SPAN
+>. (See
+ "Building and releasing packages" above). Then add a log
+ entry to <TT
+CLASS="FILENAME"
+>debian/changelog</TT
+>, if it is not
+ already there, for example by running:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
+> debchange -v 3.0.27-UNRELEASED-1 "New upstream version"</PRE
></TD
></TR
></TABLE
->
- </P
><P
-> Then run:
- </P
-><P
-> <TABLE
+> Then, run:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> cd osxsetup
- build</PRE
+> dpkg-buildpackage -rfakeroot -us -uc -b</PRE
></TD
></TR
></TABLE
->
- </P
><P
-> This will run <TT
-CLASS="FILENAME"
->autoheader</TT
->, <TT
-CLASS="FILENAME"
->autoconf</TT
-> and
- <TT
-CLASS="FILENAME"
->configure</TT
-> as well as <TT
-CLASS="FILENAME"
->make</TT
->.
- Finally, it will copy over the necessary files to the ./osxsetup/files directory
- for further processing by <TT
+> This will create
+ <TT
CLASS="FILENAME"
->PackageMaker</TT
->.
- </P
-><P
-> Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
- name to match the release, and hit the "Create package" button.
- If you specify ./Privoxy.pkg as the output package name, you can then create
- the distributable zip file with the command:
- </P
-><P
-> <TABLE
+>../privoxy_3.0.27-UNRELEASED-1_i386.deb</TT
+>
+ which can be uploaded. To upload the package to Sourceforge, simply
+ issue
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
->zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</PRE
+> make debian-upload</PRE
></TD
></TR
></TABLE
->
- </P
-><P
-> You can then upload <TT
-CLASS="FILENAME"
->privoxyosx_setup_x.y.z.zip</TT
-> anonymously to
- <TT
-CLASS="FILENAME"
->uploads.sourceforge.net/incoming</TT
->,
- create a release for it, and you're done. Use the release notes
- and Change Log from the source tarball package.
- </P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-FREEBSD"
->6.3.9. FreeBSD</A
+NAME="NEWRELEASE-MACOSX"
+>6.3.8. Mac OS X</A
></H3
><P
-> Login to Sourceforge's compilefarm via ssh:
- </P
+> First, <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>make sure that you have freshly exported the right
+ version into an empty directory</I
+></SPAN
+>. (See "Building and releasing
+ packages" above).
+ </P
+><P
+> There are three modules available in the Git repository for use on Mac
+ OS X, though technically only two of them generate a release (the other
+ can be used to install from source).
+ </P
+><DIV
+CLASS="SECT4"
+><H4
+CLASS="SECT4"
+><A
+NAME="OS-X-OSXPACKAGEBUILDER-MODULE"
+>6.3.8.1. OSXPackageBuilder module</A
+></H4
><P
-> <TABLE
+> The OSXPackageBuilder module generates OS X installer packages
+ supporting all Macs running OS X 10.4 and above. Obtain it from Git as
+ follows into a folder parallel to the exported privoxy source:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> ssh cf.sourceforge.net</PRE
+> cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder</PRE
></TD
></TR
></TABLE
->
- </P
><P
-> Choose the right operating system.
- When logged in, <I
+> The module contains complete instructions on its usage in the file
+ <TT
+CLASS="FILENAME"
+>OS X Package Builder HOWTO.txt</TT
+>.
+ </P
+><P
+> Once the package(s) have been generated, you can then upload them
+ directly to the Files section of the Sourceforge project in the
+ Macintosh (OS X) folder. Each new version release of Privoxy should
+ have a new subfolder created in which to store its files. Please
+ ensure that the folder contains a readme file that makes it clear
+ which package is for whichversion of OS X.
+ </P
+></DIV
+><DIV
+CLASS="SECT4"
+><H4
+CLASS="SECT4"
+><A
+NAME="OS-X-OSXSETUP-MODULE"
+>6.3.8.2. osxsetup module (DEPRECATED)</A
+></H4
+><P
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
->make sure that you have freshly exported the right
- version into an empty directory</I
->. (See "Building and releasing
- packages" above). Then run:
- </P
+>This module is deprecated since the installer it generates
+ places all Privoxy files in one folder in a non-standard location, and
+ supports only Intel Macs running OS X 10.6 or higher.</I
+></SPAN
+>
+ </P
><P
-> <TABLE
+> Check out the module from Git as follows into a folder parallel to the
+ exported privoxy source:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> cd current
- autoheader && autoconf && ./configure</PRE
+> cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
></TD
></TR
></TABLE
->
- </P
><P
-> Then run:
- </P
-><P
-> <TABLE
+> Then run:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> gmake freebsd-dist</PRE
+> cd osxsetup
+ build</PRE
></TD
></TR
></TABLE
->
- </P
><P
-> which creates a gzip'ed tar archive. Sadly, you cannot use <B
-CLASS="COMMAND"
->make
- freebsd-upload</B
-> on the Sourceforge machine (no ncftpput). You now have
- to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
- source tarball package.
- </P
-></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
-NAME="NEWRELEASE-HPUX"
->6.3.10. HP-UX 11</A
-></H3
-><P
-> First, <I
-CLASS="EMPHASIS"
->make sure that you have freshly exported the right
- version into an empty directory</I
->. (See "Building and releasing
- packages" above). Then run:
- </P
+> This will run <TT
+CLASS="FILENAME"
+>autoheader</TT
+>, <TT
+CLASS="FILENAME"
+>autoconf</TT
+>
+ and <TT
+CLASS="FILENAME"
+>configure</TT
+> as well as <TT
+CLASS="FILENAME"
+>make</TT
+>.
+ Finally, it will copy over the necessary files to the ./osxsetup/files
+ directory for further processing by <TT
+CLASS="FILENAME"
+>PackageMaker</TT
+>.
+ </P
><P
-> <TABLE
+> Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
+ modify the package name to match the release, and hit the "Create
+ package" button. If you specify ./Privoxy.pkg as the output package
+ name, you can then create the distributable zip file with the command:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> cd current
- autoheader && autoconf && ./configure</PRE
+> zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</PRE
></TD
></TR
></TABLE
->
- </P
><P
-> Then do FIXME.
- </P
+> You can then upload this file directly to the Files section of the
+ Sourceforge project in the Macintosh (OS X) folder. Each new version
+ release of Privoxy should have a new subfolder created in which to
+ store its files.
+ Please ensure that the folder contains a readme file that makes it
+ clear which version(s) of OS X the package supports.
+ </P
></DIV
><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
+CLASS="SECT4"
+><H4
+CLASS="SECT4"
><A
-NAME="NEWRELEASE-AMIGA"
->6.3.11. Amiga OS</A
-></H3
+NAME="OS-X-MACSETUP-MODULE"
+>6.3.8.3. macsetup module</A
+></H4
><P
-> First, <I
-CLASS="EMPHASIS"
->make sure that you have freshly exported the right
- version into an empty directory</I
->. (See "Building and releasing
- packages" above). Then run:
- </P
+> The macsetup module is ideal if you wish to build and install Privoxy
+ from source on a single machine.
+ </P
><P
-> <TABLE
+> Check out the module from Git as follows into a folder parallel to the
+ exported privoxy source:
+ </P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> cd current
- autoheader && autoconf && ./configure</PRE
+> cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup</PRE
></TD
></TR
></TABLE
->
- </P
><P
-> Then do FIXME.
- </P
+> The module contains complete instructions on its usage in its
+ <TT
+CLASS="FILENAME"
+>README</TT
+> file. The end result will be the
+ exported version of Privoxy installed on the build machine.
+ </P
+></DIV
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-AIX"
->6.3.12. AIX</A
+NAME="NEWRELEASE-FREEBSD"
+>6.3.9. FreeBSD</A
></H3
><P
-> Login to Sourceforge's compilefarm via ssh:
- </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="PROGRAMLISTING"
-> ssh cf.sourceforge.net</PRE
-></TD
-></TR
-></TABLE
->
- </P
-><P
-> Choose the right operating system.
- When logged in, <I
-CLASS="EMPHASIS"
->make sure that you have freshly exported the right
- version into an empty directory</I
->. (See "Building and releasing
- packages" above). Then run:
- </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="PROGRAMLISTING"
-> cd current
- autoheader && autoconf && ./configure</PRE
-></TD
-></TR
-></TABLE
->
- </P
-><P
-> Then run:
- </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="PROGRAMLISTING"
-> make aix-dist</PRE
-></TD
-></TR
-></TABLE
->
- </P
-><P
-> which creates a gzip'ed tar archive. Sadly, you cannot use <B
-CLASS="COMMAND"
->make
- aix-upload</B
-> on the Sourceforge machine (no ncftpput). You now have
- to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
- source tarball package.
- </P
+> Update the www/privoxy port and submit a diff upstream.
+ For details see the <A
+HREF="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/"
+TARGET="_top"
+>FreeBSD Porter's Handbook</A
+>.
+ </P
></DIV
></DIV
><DIV
>6.4. Uploading and Releasing Your Package</A
></H2
><P
-> After the package is ready, it is time to upload it
+> After the package is ready, it is time to upload it
to SourceForge, and go through the release steps. The upload
is done via FTP:
</P
><P
-> <P
></P
><UL
><LI
><P
+> Upload to: <A
HREF="ftp://upload.sourceforge.net/incoming"
TARGET="_top"
>ftp://upload.sourceforge.net/incoming</A
>
- </P
+ </P
></LI
><LI
><P
-> user: <TT
+> user: <TT
CLASS="LITERAL"
>anonymous</TT
>
- </P
+ </P
></LI
><LI
><P
-> password: <TT
+> password: <TT
CLASS="LITERAL"
>ijbswa-developers@lists.sourceforge.net</TT
>
- </P
+ </P
></LI
></UL
->
- </P
><P
> Or use the <B
CLASS="COMMAND"
> targets as described above.
</P
><P
-> Once this done go to <A
-HREF="http://sourceforge.net/project/admin/editpackages.php?group_id=11118"
+> Once this done go to
+ <A
+HREF="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
TARGET="_top"
->http://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
->,
- making sure you are logged in. Find your target platform in the
+> https://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
+>,
+ making sure you are logged in. Find your target platform in the
second column, and click <TT
CLASS="LITERAL"
>Add Release</TT
->. You will
- then need to create a new release for your package, using the format
+>. You will
+ then need to create a new release for your package, using the format
of <TT
CLASS="LITERAL"
>$VERSION ($CODE_STATUS)</TT
->, e.g. <I
+>, e.g. <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
->2.9.15
+>3.0.27
(beta)</I
+></SPAN
>.
</P
><P
> Now just follow the prompts. Be sure to add any appropriate Release
- notes. You should see your freshly uploaded packages in
+ notes. You should see your freshly uploaded packages in
<SPAN
CLASS="QUOTE"
>"Step 2. Add Files To This Release"</SPAN
->. Check the
- appropriate box(es). Remember at each step to hit the
+>. Check the
+ appropriate box(es). Remember at each step to hit the
<SPAN
CLASS="QUOTE"
>"Refresh/Submit"</SPAN
-> buttons! You should now see your
- file(s) listed in Step 3. Fill out the forms with the appropriate
+> buttons! You should now see your
+ file(s) listed in Step 3. Fill out the forms with the appropriate
information for your platform, being sure to hit <SPAN
CLASS="QUOTE"
>"Update"</SPAN
>
- for each file. If anyone is monitoring your platform, check the
+ for each file. If anyone is monitoring your platform, check the
<SPAN
CLASS="QUOTE"
>"email"</SPAN
-> box at the very bottom to notify them of
+> box at the very bottom to notify them of
the new package. This should do it!
</P
><P
-> If you have made errors, or need to make changes, you can go through
+> If you have made errors, or need to make changes, you can go through
essentially the same steps, but select <TT
CLASS="LITERAL"
>Edit Release</TT
->,
+>,
instead of <TT
CLASS="LITERAL"
>Add Release</TT
></H2
><P
> When all (or: most of the) packages have been uploaded and made available,
- send an email to the <A
-HREF="mailto:ijbswa-announce@lists.sourceforge.net"
+ send an email to the
+ <A
+HREF="mailto:privoxy-announce@lists.privoxy.org"
TARGET="_top"
->announce
- mailing list</A
+>announce mailing
+ list</A
>, Subject: "Version X.Y.Z available for download". Be sure to
include the
<A
-HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
+HREF="https://sourceforge.net/project/showfiles.php?group_id=11118"
TARGET="_top"
->download
- location</A
->, the release notes and the change log.
+> download location</A
+>, the release notes and the Changelog. Also, post an
+ updated News item on the project page Sourceforge, and update the Home
+ page and docs linked from the Home page (see below). Other news sites
+ and release oriented sites, such as Freshmeat, should also be notified.
+ </P
+><P
+> Then update the source code for the next version to be released:
</P
+><P
+></P
+><UL
+><LI
+><P
+> Increment the version number and change the code status to "UNRELEASED"
+ in <TT
+CLASS="FILENAME"
+>configure.in</TT
+>
+ </P
+></LI
+><LI
+><P
+> Rebuild configure (<SPAN
+CLASS="QUOTE"
+>"<B
+CLASS="COMMAND"
+>autoheader && autoconf</B
+>"</SPAN
+>)
+ and GNUMakefile (<SPAN
+CLASS="QUOTE"
+>"<B
+CLASS="COMMAND"
+>./configure</B
+>"</SPAN
+>)
+ </P
+></LI
+><LI
+><P
+> <SPAN
+CLASS="QUOTE"
+>"<B
+CLASS="COMMAND"
+>make dok-release</B
+>"</SPAN
+> to update the sgml documentation source files.
+ </P
+></LI
+><LI
+><P
+> Commit all your changes.
+ </P
+></LI
+></UL
></DIV
></DIV
><DIV
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="testing.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="webserver-update.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
projects / privoxy.git / blobdiff