<!entity p-intro SYSTEM "privoxy.sgml">
<!entity history SYSTEM "history.sgml">
<!entity seealso SYSTEM "seealso.sgml">
-<!entity p-version "3.0.30">
+<!entity p-version "3.0.33">
<!entity p-status "UNRELEASED">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
Purpose : developer manual
- Copyright (C) 2001-2020 Privoxy Developers https://www.privoxy.org/
+ Copyright (C) 2001-2021 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
<!-- Completely the wrong markup, but very little is allowed -->
<!-- in this part of an article. FIXME -->
<ulink url="https://www.privoxy.org/user-manual/copyright.html">Copyright</ulink>
- &my-copy; 2001-2020 by
+ &my-copy; 2001-2021 by
<ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
</subscript>
</pubdate>
course this, the <citetitle>developer-manual</citetitle> in this format.
The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
<citetitle>INSTALL</citetitle>,
- <citetitle>privoxy.1</citetitle> (man page), and
+ <citetitle>privoxy.8</citetitle> (man page), and
<citetitle>config</citetitle> files are also now maintained as Docbook
SGML. These files, when built, in the top-level source directory are
generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
2020-12-14 12:17:56: Ooops. Expected removal but: 'Referer: https://p.p/' is still there.
2020-12-14 12:17:56: Failure for test 785 (0/13/5). Header 'Referer: https://p.p/' and tag 'hide-referrer{conditional-block}'
2020-12-14 12:17:56: Executed 1 regression tests. Skipped 1201. 0 successes, 1 failures.
- </programlisting>
+</programlisting>
<para>
Use the if the <command>--privoxy-address</command> option if the
http_proxy environment variable isn't configured and you don't want
</listitem>
<listitem>
<para>
- Update the code status (CODE_STATUS="xxx") in configure.in to one of
+ Update the code status (CODE_STATUS="xxx") in <filename>configure.in</filename> to one of
"alpha", "beta" or "stable".
</para>
</listitem>
<para>
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:
+ <filename>default.action.master</filename> has been updated:
</para>
<programlisting>
{{settings}}
Create the change log:
</para>
<programlisting>
- $ git tag
- # to see the tags
- $ git log [last release tag]..master > /tmp/log
- # get the commit log since the last release
- $ utils/makeChangeLog /tmp/log > /tmp/change.log
- # reformat the commit log
+$ git tag
+# to see the tags
+$ git log [last release tag]..master > /tmp/log
+# get the commit log since the last release
+$ utils/makeChangeLog /tmp/log > /tmp/change.log
+# reformat the commit log
</programlisting>
<para>
Edit <filename>/tmp/change.log</filename> to remove trivial
<filename>doc/source/changelog.sgml</filename>:
</para>
<programlisting>
- $ utils/changelog2doc.pl /tmp/change.log >| doc/source/changelog.sgml
+$ utils/changelog2doc.pl /tmp/change.log >| doc/source/changelog.sgml
</programlisting>
</listitem>
<listitem>
make sure noteworthy changes are referenced.
</para>
</listitem>
+ <listitem>
+ <para>
+ Update the announcement at <filename>doc/webserver/announce.txt</filename>.
+ </para>
+ </listitem>
<listitem>
<para>
All documentation should be rebuilt:
<programlisting>
- $ make man
- $ make dok
- $ make dok-man
- $ make dok-tidy
- $ make config-file
+$ make man
+$ make dok
+$ make dok-man
+$ make dok-tidy
+$ make config-file
</programlisting>
Finished docs should be then be committed to Git (for those
without the ability to build these). Some docs may require
Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
</para>
</listitem>
+ <listitem>
+ <para>
+ Push the tag to the remote with
+ <quote><command>git push origin v_X_Y_Z</command></quote>.
+ </para>
+ </listitem>
<listitem>
<para>
On the webserver, copy the user manual to a new top-level directory
</para>
<programlisting>
- mkdir dist # delete or choose different name if it already exists
- cd dist
- git clone https://www.privoxy.org/git/privoxy.git
- cd privoxy
- git checkout v_X_Y_Z
+mkdir dist # delete or choose different name if it already exists
+cd dist
+git clone https://www.privoxy.org/git/privoxy.git
+cd privoxy
+git checkout v_X_Y_Z
</programlisting>
<para>
packages" above). Then run from that directory:
</para>
<programlisting>
- autoheader && autoconf && ./configure
+autoheader && autoconf && ./configure
</programlisting>
<para>
Then do:
</para>
<programlisting>
- make tarball-dist
+make tarball-dist
</programlisting>
</sect3>
First, <emphasis>make sure that you have freshly exported the right
version into an empty directory</emphasis>. (See "Building and releasing
packages" above).
- <!-- XXX ??? are we still basing releases off a tarball???
- -->
</para>
+
+ <para>
+ Check that you have the current versions of the
+ <ulink url="https://sourceforge.net/projects/nsis/files/NSIS%203/">
+ NSIS installer</ulink>,
+ <ulink url="https://ftp.pcre.org/pub/pcre/">PCRE library</ulink>,
+ <ulink url="https://tls.mbed.org/download">MBED TLS library</ulink>,
+ <ulink url="https://github.com/google/brotli/releases">
+ Brotli library</ulink>,
+ and that the <emphasis>MAKENSIS</emphasis> evar in
+ <filename>windows/GNUMakefile</filename>
+ points to the NSIS installer program. (See the
+ <ulink url="../user-manual/installation.html#WINBUILD-CYGWIN">
+ <emphasis>Building from Source / Windows</emphasis></ulink>
+ section of the User Manual for details.)
+ </para>
+
<para>
Then you can build the package. This is fully automated, and is
controlled by <filename>windows/GNUmakefile</filename>.
All you need to do is:
</para>
<programlisting>
- cd windows
- make
+cd windows
+make
</programlisting>
<para>
Now you can manually rename <filename>privoxy_setup.exe</filename> to
GPG sign the installer and zip file,
</para>
<programlisting>
- $ gpg --armor --detach --sign <filename>privoxy_setup_X.Y.Z.exe</filename>
- $ gpg --armor --detach --sign <filename>privoxy_X.Y.Z.zip</filename>
+gpg --armor --detach --sign <filename>privoxy_setup_X.Y.Z.exe</filename>
+gpg --armor --detach --sign <filename>privoxy_X.Y.Z.zip</filename>
</programlisting>
<para>
and upload the files to SourceForge.
</sect3>
<sect3 id="newrelease-debian"><title>Debian</title>
- <para>
- First, <emphasis>make sure that you have freshly exported the
- right version into an empty directory</emphasis>. (See
- "Building and releasing packages" above). Then add a log
- entry to <filename>debian/changelog</filename>, if it is not
- already there, for example by running (from the debian directory):
- </para>
- <programlisting>
- debchange -v &p-version;-&p-status;-1 "New upstream version"
-</programlisting>
- <para>
- Then, run (from the root directory):
- </para>
- <programlisting>
- dpkg-buildpackage -rfakeroot -us -uc -b
-</programlisting>
- <para>
- This will create
- <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
- which can be uploaded.
- </para>
<para>
Using git-buildpackage we start with a clone of the last Debian version:
</para>
<programlisting>
- gbp clone https://salsa.debian.org/debian/privoxy.git
- cd privoxy
- </programlisting>
+gbp clone https://salsa.debian.org/debian/privoxy.git
+cd privoxy
+</programlisting>
<para>
or if the repository is already there
</para>
<programlisting>
- cd privoxy
- gbp pull
- </programlisting>
+cd privoxy
+gbp pull
+</programlisting>
<para>
Now import the newly released upstream tarball via debian/watch file:
</para>
<programlisting>
- gbp import-orig --uscan
- </programlisting>
+gbp import-orig --uscan
+</programlisting>
<para>
Next update all Debian quilt patches to the new version:
</para>
<programlisting>
- while quilt push; do quilt refresh; done
- </programlisting>
+while quilt push; do quilt refresh; done
+</programlisting>
<para>
If some patch is no longer required (because it is already merged
upstream), it can be removed using
</para>
<programlisting>
- quilt delete XX_patchname.patch
- git rm debian/patches/XX_patchname.patch
- </programlisting>
+quilt delete XX_patchname.patch
+git rm debian/patches/XX_patchname.patch
+</programlisting>
<para>
If the patch needs modification, you can apply, edit and update it with
</para>
<programlisting>
- quilt push -f
- quilt edit some_file
- quilt refresh
- </programlisting>
+quilt push -f
+quilt edit some_file
+quilt refresh
+</programlisting>
<para>
until
</para>
<programlisting>
- while quilt push; do quilt refresh; done
- </programlisting>
+while quilt push; do quilt refresh; done
+</programlisting>
<para>
succeeds. Then you can
</para>
<programlisting>
- quilt pop -a
- </programlisting>
+quilt pop -a
+</programlisting>
<para>
Now add a new entry to the debian/changelog representing the new
version:
</para>
<programlisting>
- dch -v &p-version;-1
- </programlisting>
+dch -v &p-version;-1
+</programlisting>
<para>
and describe what you did before and don't forget to git commit all
changes.
Now you can build the package on the local machine using
</para>
<programlisting>
- gbp buildpackage -us -uc
- </programlisting>
+gbp buildpackage -us -uc
+</programlisting>
<para>
You should check for warnings using
</para>
<programlisting>
- lintian -iI ../build-area/privoxy_&p-version;-1_amd64.changes
- </programlisting>
+lintian -iI ../build-area/privoxy_&p-version;-1_amd64.changes
+</programlisting>
<para>
Maybe rebuild the package in different defined cowbuilder environments
like
</para>
<programlisting>
- sudo cowbuilder --build --basepath /var/cache/pbuilder/base.cow ../build-area/privoxy_&p-version;-1.dsc
- </programlisting>
+sudo cowbuilder --build --basepath /var/cache/pbuilder/base.cow ../build-area/privoxy_&p-version;-1.dsc
+</programlisting>
<para>
And try to run autopackage testing suite on the result:
</para>
<programlisting>
- autopkgtest /var/cache/pbuilder/result/privoxy_&p-version;-1_amd64.changes -s -- schroot sid
- </programlisting>
+autopkgtest /var/cache/pbuilder/result/privoxy_&p-version;-1_amd64.changes -s -- schroot sid
+</programlisting>
<para>
Or just push the changes to salsa.debian.org, where a CI pipeline is
defined for the package, that builds and tests it.
Then sign both files:
</para>
<programlisting>
- gpg --detach-sign --armor privoxy_&p-version;-1_i386.deb
- gpg --detach-sign --armor privoxy_&p-version;-1_amd64.deb
- </programlisting>
+gpg --detach-sign --armor privoxy_&p-version;-1_i386.deb
+gpg --detach-sign --armor privoxy_&p-version;-1_amd64.deb
+</programlisting>
<para>
Create a README file containing the recent block from debian/changelog
and upload the two packages, the two signatures and the README to a
freshly created folder below
https://sourceforge.net/projects/ijbswa/files/Debian/
</para>
+
+ <sect4 id="snapshot-debian"><title>Debian GIT Snapshot</title>
<para>
For building just a git snapshot build the following workflow may be
useful. First create a build environment, for this you may have to
run the following commands:
</para>
<programlisting>
- sudo apt install build-essential devscripts
- sudo apt-get build-dep privoxy
- </programlisting>
+sudo apt install build-essential devscripts
+sudo apt-get build-dep privoxy
+</programlisting>
<para>
After this enter the checked out privoxy git tree and check that all
(new) build dependencies are met:
</para>
<programlisting>
- dpkg-checkbuilddeps
- </programlisting>
+dpkg-checkbuilddeps
+</programlisting>
<para>
If something is missing, just add it using
</para>
<programlisting>
- sudo apt install foobar
- </programlisting>
+sudo apt install foobar
+</programlisting>
<para>
Now you may update debian/changelog, especially the version number
using
</para>
<programlisting>
- dch
- </programlisting>
+dch
+</programlisting>
<para>
and finally build the package:
</para>
<programlisting>
- debuild -us -uc -b
- </programlisting>
+debuild -us -uc -b
+</programlisting>
<para>
If everything went okay, you may find the resulting Debian package in
the parent directory.
You may want to clean up the build tree using
</para>
<programlisting>
- debian/rules clean
- </programlisting>
+debian/rules clean
+</programlisting>
<para>
And maybe repair some artefacts using one or both of the following
commands:
</para>
<programlisting>
- git reset --hard
- git clean -fd
- </programlisting>
-
+git reset --hard
+git clean -fd
+</programlisting>
+ </sect4>
</sect3>
<sect3 id="newrelease-macosx"><title>Mac OS X</title>
follows into a folder parallel to the exported privoxy source:
</para>
<programlisting>
- cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
+cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
</programlisting>
+<!-- FIXME cvs is no more!!! -->
<para>
The module contains complete instructions on its usage in the file
<filename>OS X Package Builder HOWTO.txt</filename>.
exported privoxy source:
</para>
<programlisting>
- cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
+cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
</programlisting>
+<!-- FIXME cvs is no more -->
<para>
Then run:
</para>
<programlisting>
- cd osxsetup
- build
+cd osxsetup
+build
</programlisting>
<para>
This will run <filename>autoheader</filename>, <filename>autoconf</filename>
name, you can then create the distributable zip file with the command:
</para>
<programlisting>
- zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
+zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
</programlisting>
<para>
You can then upload this file directly to the Files section of the
exported privoxy source:
</para>
<programlisting>
- cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
+cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
</programlisting>
+<!-- FIXME cvs is no more -->
<para>
The module contains complete instructions on its usage in its
<filename>README</filename> file. The end result will be the
SGML files, do:
</para>
<programlisting>
- make dok
+make dok && make dok-tidy
</programlisting>
<para>
That will generate <filename>doc/webserver/user-manual</filename>,
If these are docs in the stable branch, then do:
</para>
<programlisting>
- make webserver
+make webserver
</programlisting>
<para>
This will do the upload to the SourceForge webserver (which is manually
projects / privoxy.git / blobdiff