<!entity p-intro SYSTEM "privoxy.sgml">
<!entity history SYSTEM "history.sgml">
<!entity seealso SYSTEM "seealso.sgml">
-<!entity contacting SYSTEM "contacting.sgml">
-<!entity copyright SYSTEM "copyright.sgml">
-<!entity license SYSTEM "license.sgml">
-<!entity p-version "3.0.20">
+<!entity p-version "3.0.27">
<!entity p-status "UNRELEASED">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
<!entity my-copy "©"> <!-- kludge for docbook2man -->
]>
<!--
- File : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
+ File : doc/source/developer-manual.sgml
Purpose : developer manual
- This file belongs into
- ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 2.50 2012/05/27 15:31:24 fabiankeil Exp $
-
- Copyright (C) 2001-2012 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
<subscript>
<!-- Completely the wrong markup, but very little is allowed -->
<!-- in this part of an article. FIXME -->
- <link linkend="copyright">Copyright</link> &my-copy; 2001-2009 by
- <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
+ <ulink url="https://www.privoxy.org/user-manual/copyright.html">Copyright</ulink>
+ &my-copy; 2001-2018 by
+ <ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
</subscript>
</pubdate>
-
- <pubdate>$Id: developer-manual.sgml,v 2.50 2012/05/27 15:31:24 fabiankeil Exp $</pubdate>
-
<!--
Note: this should generate a separate page, and a live link to it.
Please note that this document is constantly evolving. This copy represents
the state at the release of version &p-version;.
You can find the latest version of the this manual at <ulink
- url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
- Please see <link linkend="contact">the Contact section</link>
- on how to contact the developers.
+ url="https://www.privoxy.org/developer-manual/">https://www.privoxy.org/developer-manual/</ulink>.
+ Please have a look at the
+ <ulink url="https://www.privoxy.org/user-manual/contact.html">contact section in the user manual</ulink>
+ if you are interested in contacting the developers.
</para>
-<!-- <para> -->
-<!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
-<!-- </para> -->
</abstract>
</artheader>
<sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
<para>
The first step is to join the <ulink
- url="mailto:ijbswa-developers@lists.sourceforge.net">developer's mailing list</ulink>.
+ url="https://lists.privoxy.org/mailman/listinfo/privoxy-devel">privoxy-devel mailing list</ulink>.
You can submit your ideas, or even better patches. Patches are best
submitted to the Sourceforge tracker set up for this purpose, but
can be sent to the list for review too.
<sect2 id="cvsaccess"><title>Access to CVS</title>
<para>
The project's CVS repository is hosted on
- <ulink url="http://sourceforge.net/">SourceForge.</ulink>
- Please refer to the chapters 6 and 7 in
- <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
- documentation</ulink> for the technical access details for your
- operating system. For historical reasons, the CVS server is
+ <ulink url="https://sourceforge.net/">SourceForge.</ulink>
+ For historical reasons, the CVS server is
called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
called <literal>ijbswa</literal>, and the source tree module is called
<literal>current</literal>.
mentioned, the sources are in the <literal>current</literal>
<quote>module</quote>. Other modules are present for platform specific
issues. There is a webview of the CVS hierarchy at <ulink
- url="http://ijbswa.cvs.sourceforge.net/ijbswa/">http://ijbswa.cvs.sourceforge.net/ijbswa/</ulink>,
+ url="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/"
+ >http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</ulink>,
which might help with visualizing how these pieces fit together.
</para>
<!--
<para>
Basic Guidelines, for all branches:
</para>
- <para>
<itemizedlist>
<listitem><para>
Please don't commit even
<para>
Note that near a major public release, we get more cautious.
There is always the possibility to submit a patch to the <ulink
- url="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
+ url="https://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patch
tracker</ulink> instead.
</para>
</listitem>
</itemizedlist>
- </para>
<!--
<para>
<para>
Alternately, proposed changes can be submitted as patches to the patch tracker on
Sourceforge first: <ulink
- url="http://sourceforge.net/tracker/?group_id=11118&atid=311118">http://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
+ url="https://sourceforge.net/tracker/?group_id=11118&atid=311118">https://sourceforge.net/tracker/?group_id=11118&atid=311118</ulink>.
Then ask for peer review.
</para>
</listitem>
</para>
<para>
How do you update the webserver (i.e. the pages on privoxy.org)?
+ </para>
<orderedlist numeration="arabic">
<listitem><para>
sourceforge webserver via scp.
</para></listitem>
</orderedlist>
- </para>
<para>
Finished docs should be occasionally submitted to CVS
Some common elements that you likely will use:
</para>
-<para>
<simplelist>
<member>
<emphasis><para></para></emphasis>, paragraph delimiter. Most
<emphasis><quote></quote></emphasis>, for, doh, quoting text.
</member>
</simplelist>
-</para>
<para>
Look at any of the existing docs for examples of all these and more.
</para>
<para>
- You might also find <quote><ulink
- url="http://opensource.bureau-cornavin.com/crash-course/index.html">Writing Documentation
- Using DocBook - A Crash Course</ulink></quote> useful.
+ You might also find
+ <!-- <quote><ulink url="http://opensource.bureau-cornavin.com/crash-course/index.html">
+ domain no longer exists so link to the wayback archive -->
+ <quote><ulink url="https://web.archive.org/web/20160315230758/http://opensource.bureau-cornavin.com/crash-course/index.html">
+ Writing Documentation Using DocBook - A Crash Course</ulink></quote> useful.
</para>
</sect2>
<para>
Here it is:
</para>
- <para>
<itemizedlist>
<listitem>
<para>
<para>
Tags delimiting a <emphasis>block</emphasis> of text (even small
blocks) should be on their own line. Like:
+ </para>
<literallayout>
<para>
Some text goes here.
</para>
</literallayout>
+ <para>
Tags marking individual words, or few words, should be in-line:
+ </para>
<literallayout>
Just to <emphasis>emphasize</emphasis>, some text goes here.
</literallayout>
- </para>
</listitem>
<listitem>
<para>
Tags should be nested and step indented for block text like: (except
in-line tags)
+ </para>
<literallayout>
<para>
<itemizedlist>
</itemizedlist>
</para>
</literallayout>
+ <para>
This makes it easier to find the text amongst the tags ;-)
</para>
</listitem>
</listitem>
</itemizedlist>
- </para>
</sect2>
custom entities are listed below. See any of the main docs for examples.
</para>
- <para>
<itemizedlist>
<listitem>
<para>
</simplelist>
</listitem>
</itemizedlist>
- </para>
<para>
There are others in various places that are defined for a specific
purpose. Read the source!
<para><emphasis>Instead of:</emphasis></para>
- <para>
<programlisting>
int msiis5hack = 0; int msIis5Hack = 0;
</programlisting>
-</para>
<para><emphasis>Instead of:</emphasis></para>
- <para>
<programlisting>
int loadsomefile(struct client_state *csp)
int loadSomeFile(struct client_state *csp)
</programlisting>
-</para>
</sect3>
(.h) extern int load_aclfile(struct client_state *csp);
(.c) int load_aclfile(struct client_state *csp)</programlisting>
- <para><emphasis>Instead of:</emphasis>
+ <para><emphasis>Instead of:</emphasis></para>
<programlisting>
(.h) extern int load_aclfile(struct client_state *); or
(.h) extern int load_aclfile();
(.c) int load_aclfile(struct client_state *csp)
</programlisting>
-</para>
</sect3>
<para><emphasis>Instead of:</emphasis></para>
- <para>
<programlisting>
#define USE_IMG_LST 1 or
#define _USE_IMAGE_LIST 1 or
#define use_image_list 1 or
#define UseImageList 1
</programlisting>
-</para>
</sect3>
<para><emphasis>Exception:</emphasis></para>
- <para>
<programlisting>
/* This is not a local include, but requires a path element. */
#include <sys/fileName.h>
</programlisting>
-</para>
<para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
without a _very_ good reason. This duplicates the #include
* Purpose : (Fill me in with a good description!)
*
* Copyright : Written by and Copyright (C) 2001-2009
- * the Privoxy team. http://www.privoxy.org/
+ * the Privoxy team. https://www.privoxy.org/
*
* This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
</programlisting>
<para><emphasis>Note:</emphasis> This declares the rcs variables that should be
- added to the "show-proxy-args" page. If this is a brand new
+ added to the "show-version" page. If this is a brand new
creation by you, you are free to change the "Copyright" section
to represent the rights you wish to maintain.</para>
* Purpose : (Fill me in with a good description!)
*
* Copyright : Written by and Copyright (C) 2001-2009
- * the Privoxy team. http://www.privoxy.org/
+ * the Privoxy team. https://www.privoxy.org/
*
* This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
<sect2 id="testing-plan"><title>Testplan for releases</title>
<para>
Explain release numbers. major, minor. developer releases. etc.
-
+ </para>
<orderedlist numeration="arabic">
<listitem><para>
Remove any existing rpm with rpm -e
</para></listitem>
<listitem><para>
Remove any file that was left over. This includes (but is not limited to)
+ </para>
<itemizedlist>
<listitem><para>/var/log/privoxy</para></listitem>
<listitem><para>/etc/privoxy</para></listitem>
<listitem><para>/etc/init.d/privoxy</para></listitem>
<listitem><para>/usr/doc/privoxy*</para></listitem>
</itemizedlist>
-</para></listitem>
+ </listitem>
<listitem><para>
Install the rpm. Any error messages?
</para></listitem>
<listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
<listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
</orderedlist>
-</para>
</sect2>
+ <!-- XXX: Document how to write test reports and where to send them -->
<!-- ~~~~~ New section ~~~~~ -->
- <sect2 id="testing-report"><title>Test reports</title>
- <para>
-Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
-at sourceforge. Three simple steps:
- <itemizedlist>
-
- <listitem><para>Select category: the distribution you test on.</para></listitem>
- <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
- <listitem><para>Fill the Summary and Detailed Description with something
- intelligent (keep it short and precise).</para>
- </listitem>
- </itemizedlist>
- Do not mail to the mailing list (we cannot keep track on issues there).
- </para>
+ <sect2 id="fuzzing"><title>Fuzzing Privoxy</title>
+ <para>
+ To make fuzzing more convenient, Privoxy can be configured
+ with --enable-fuzz which will result in the --fuzz option
+ becoming available.
+ </para>
+ <para>
+ Example (tested on ElectroBSD):
+ </para>
+ <programlisting>
+# Compile Privoxy with instrumentation for afl
+$ export CC=afl-clang
+$ export CFLAGS="-fsanitize=address -ggdb"
+$ export CPPFLAGS=-I/usr/local/include/
+$ export LDFLAGS="-fsanitize=address -L/usr/local/lib"
+$ export AFL_USE_ASAN=1
+$ export AFL_HARDEN=1
+$ ./configure --with-debug --enable-extended-host-patterns --enable-accept-filter --enable-no-gifs --enable-compression --enable-strptime-sanity-checks --enable-external-filters --enable-fuzz
+
+$ ./privoxy --fuzz
+Privoxy version 3.0.24 (http://www.privoxy.org/)
+Usage: ./privoxy [--config-test] [--chroot] [--help] [--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] [--version] [configfile]
+ ./privoxy --fuzz fuzz-mode ./path/to/fuzzed/input [--stfu]
+
+Supported fuzz modes and the expected input:
+ action: Text to parse as action file.
+ client-request: Client request to parse. Currently incomplete
+ client-header: Client header to parse.
+ chunked-transfer-encoding: Chunk-encoded data to dechunk.
+ deflate: deflate-compressed data to decompress.
+ filter: Text to parse as filter file.
+ gif: gif to deanimate.
+ gzip: gzip-compressed data to decompress.
+ pcrs-substitute: A pcrs-substitute to compile. Not a whole pcrs job! Example: Bla $1 bla C $3 blah.
+ server-header: Server header to parse.
+ server-response: Server response to parse.
+
+The following fuzz modes read data from stdin if the 'file' is '-'
+ client-request
+ client-header
+ chunked-transfer-encoding
+ deflate
+ gif
+ gzip
+ pcrs-substitute
+ server-header
+ server-response
+
+Aborting
+
+$ export ASAN_OPTIONS='abort_on_error=1'
+$ mkdir input output
+$ echo '$1 bla fasel $2' > input/pcrs
+$ afl-fuzz -i input -o output -m none ~/git/privoxy/privoxy --fuzz pcrs-substitute - --stfu
+
+$ cat >input/pcrs.txt
+FILTER: bla fasel
+s@(.{1})[432](\d+)@$1$2$hostname@UgisT
+
+$ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla.filter --stfu
+</programlisting>
</sect2>
-
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
First you need to determine which version number the release will have.
<application>Privoxy</application> version numbers consist of three numbers,
separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
+ </para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
- </para>
<para>
In summary, the main CVS trunk is the development branch where new
features are being worked on for the next stable series. This should
The following <emphasis>must be done by one of the
developers</emphasis> prior to each new release.
</para>
- <para>
<itemizedlist>
<listitem>
<para>
<listitem>
<para>
Increment the version number (point from odd to even in development
- branches!) in <filename>configure.in</filename>. (RPM spec files
- will need to be incremented as well.)
+ branches!) in <filename>configure.in</filename> and update the code
+ status (CODE_STATUS="xxx") to one of "alpha", "beta" or "stable".
+ Rebuild configure and GNUMakefile to make sure the updated values are
+ being used.
</para>
</listitem>
<listitem>
<para>
- If <filename>default.action</filename> 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:
+ Use the dok-release target to update the sgml documentation source files.
</para>
+ </listitem>
+ <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:
+ </para>
<programlisting>
- {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
+{{settings}}
+#############################################################################
+#MASTER# COMMENT: The minimum Privoxy version:
+for-privoxy-version=3.0.11
</programlisting>
- </para>
- <para>
- Then change the version info in doc/webserver/actions/index.php,
- line: '$required_actions_file_version = "A.B";'
- </para>
</listitem>
<listitem>
<para>
Finished docs should be then be committed to CVS (for those
without the ability to build these). Some docs may require
rather obscure processing tools. <filename>config</filename>,
- the man page (and the html version of the man page), and the PDF docs
- fall in this category. REAMDE, the man page, AUTHORS, and config
+ 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 CVS for other packagers. The
formal docs should be uploaded to the webserver. See the
Section "Updating the webserver" in this manual for details.
</para>
</listitem>
</itemizedlist>
- </para>
</sect2>
<sect2 id="therelease">
asked for a password):
</para>
- <para>
<programlisting>
mkdir dist # delete or choose different name if it already exists
cd dist
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
</programlisting>
- </para>
<para>
<emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
Please keep these general guidelines in mind when putting together
your package. These apply to <emphasis>all</emphasis> platforms!
</para>
- <para>
<itemizedlist>
<listitem>
<para>
</listitem>
</itemizedlist>
- </para>
</sect3>
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then run:
</para>
- <para>
<programlisting>
cd current
autoheader && autoconf && ./configure
</programlisting>
- </para>
<para>
Then do:
</para>
- <para>
<programlisting>
make tarball-dist
</programlisting>
- </para>
<para>
To upload the package to Sourceforge, simply issue
</para>
- <para>
<programlisting>
make tarball-upload
</programlisting>
- </para>
<para>
Go to the displayed URL and release the file publicly on Sourceforge.
For the change log field, use the relevant section of the
be reset to one if this is the first RPM for
<replaceable class="parameter">dist</replaceable> which is built from version
X.Y.Z. Check the
- <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">file
+ <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">file
list</ulink> if unsure. Else, it must be set to the highest already available RPM
release number for that version plus one.
</para>
<para>
Then run:
</para>
- <para>
<programlisting>
cd current
autoheader && autoconf && ./configure
</programlisting>
- </para>
<para>
Then do
</para>
- <para>
<programlisting>
make <replaceable class="parameter">dist</replaceable>-dist
</programlisting>
- </para>
<para>
To upload the package to Sourceforge, simply issue
</para>
- <para>
<programlisting>
make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
</programlisting>
- </para>
<para>
where <replaceable class="parameter">rpm_packagerev</replaceable> is the
RPM release number as determined above.
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then get the OS/2 Setup module:
</para>
- <para>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
</programlisting>
- </para>
<para>
You will need a mix of development tools.
The main compilation takes place with IBM Visual Age C++.
Edit the os2build.cmd file to set the final executable filename.
For example,
</para>
- <para>
<programlisting>
installExeName='privoxyos2_setup_X.Y.Z.exe'
</programlisting>
- </para>
<para>
Next, edit the <filename>IJB.wis</filename> file so the release number matches
in the <filename>PACKAGEID</filename> section:
</para>
- <para>
<programlisting>
PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
</programlisting>
- </para>
<para>
You're now ready to build. Run:
</para>
- <para>
<programlisting>
os2build
</programlisting>
- </para>
<para>
You will find the WarpIN-installable executable in the
<filename>./files</filename> directory. Upload this anonymously to
<para>
Login to Sourceforge's compilefarm via ssh:
</para>
- <para>
<programlisting>
ssh cf.sourceforge.net
</programlisting>
- </para>
<para>
Choose the right operating system (not the Debian one).
When logged in, <emphasis>make sure that you have freshly exported the right
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then run:
</para>
- <para>
<programlisting>
cd current
autoheader && autoconf && ./configure
</programlisting>
- </para>
<para>
Then run
</para>
- <para>
<programlisting>
gmake solaris-dist
</programlisting>
- </para>
<para>
which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
<sect3 id="newrelease-windows"><title>Windows</title>
<para>
- You should ensure you have the latest version of Cygwin (from
- <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>).
- Run the following commands from within a Cygwin bash shell.
+ Use the <ulink url="http://www.fruitbat.org/Cygwin/index.html#cygwincirca">
+ Cygwin Time Machine</ulink> to install the last 1.5 version of Cygwin.
+ Run the following commands from within the Cygwin 1.5 bash shell.
</para>
<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 get the Windows setup module:
</para>
- <para>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
</programlisting>
- </para>
<para>
Then you can build the package. This is fully automated, and is
controlled by <filename>winsetup/GNUmakefile</filename>.
All you need to do is:
</para>
- <para>
<programlisting>
cd winsetup
make
</programlisting>
- </para>
<para>
Now you can manually rename <filename>privoxy_setup.exe</filename> to
<filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
entry to <filename>debian/changelog</filename>, if it is not
already there, for example by running:
</para>
- <para>
<programlisting>
debchange -v &p-version;-&p-status;-1 "New upstream version"
</programlisting>
- </para>
<para>
Then, run:
</para>
- <para>
<programlisting>
dpkg-buildpackage -rfakeroot -us -uc -b
</programlisting>
- </para>
<para>
This will create
<filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
which can be uploaded. To upload the package to Sourceforge, simply
issue
</para>
- <para>
<programlisting>
make debian-upload
</programlisting>
- </para>
</sect3>
<sect3 id="newrelease-macosx"><title>Mac OS X</title>
The OSXPackageBuilder module generates OS X installer packages
supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
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
</programlisting>
- </para>
<para>
The module contains complete instructions on its usage in the file
<filename>OS X Package Builder HOWTO.txt</filename>.
<para>
Check out the module from CVS as follows into a folder parallel to the
exported privoxy source:
+ </para>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
</programlisting>
- </para>
<para>
Then run:
</para>
- <para>
<programlisting>
cd osxsetup
build
</programlisting>
- </para>
<para>
This will run <filename>autoheader</filename>, <filename>autoconf</filename>
and <filename>configure</filename> as well as <filename>make</filename>.
package" button. If you specify ./Privoxy.pkg as the output package
name, you can then create the distributable zip file with the command:
</para>
- <para>
<programlisting>
zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
</programlisting>
- </para>
<para>
You can then upload this file directly to the Files section of the
Sourceforge project in the Macintosh (OS X) folder. Each new version
<para>
Check out the module from CVS as follows into a folder parallel to the
exported privoxy source:
+ </para>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
</programlisting>
- </para>
<para>
The module contains complete instructions on its usage in its
<filename>README</filename> file. The end result will be the
<sect3 id="newrelease-freebsd"><title>FreeBSD</title>
<para>
- Login to Sourceforge's compile-farm via ssh:
- </para>
- <para>
- <programlisting>
- ssh cf.sourceforge.net
-</programlisting>
- </para>
- <para>
- Choose the right operating system.
- When logged in, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then run:
- </para>
- <para>
- <programlisting>
- cd current
- autoheader && autoconf && ./configure
-</programlisting>
- </para>
- <para>
- Then run:
- </para>
- <para>
- <programlisting>
- gmake freebsd-dist
-</programlisting>
- </para>
- <para>
- which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
- freebsd-upload</command> 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.
- </para>
- </sect3>
-
- <sect3 id="newrelease-hpux"><title>HP-UX 11</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 run:
- </para>
- <para>
- <programlisting>
- cd current
- autoheader && autoconf && ./configure
-</programlisting>
- </para>
- <para>
- Then do FIXME.
- </para>
- </sect3>
-
- <sect3 id="newrelease-amiga"><title>Amiga OS</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 run:
- </para>
- <para>
- <programlisting>
- cd current
- autoheader && autoconf && ./configure
-</programlisting>
- </para>
- <para>
- Then do FIXME.
- </para>
- </sect3>
-
- <sect3 id="newrelease-aix"><title>AIX</title>
- <para>
- Login to Sourceforge's compilefarm via ssh:
- </para>
- <para>
- <programlisting>
- ssh cf.sourceforge.net
-</programlisting>
- </para>
- <para>
- Choose the right operating system.
- When logged in, <emphasis>make sure that you have freshly exported the right
- version into an empty directory</emphasis>. (See "Building and releasing
- packages" above). Then run:
- </para>
- <para>
- <programlisting>
- cd current
- autoheader && autoconf && ./configure
-</programlisting>
- </para>
- <para>
- Then run:
- </para>
- <para>
- <programlisting>
- make aix-dist
-</programlisting>
- </para>
- <para>
- which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
- aix-upload</command> 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.
+ Update the www/privoxy port and submit a diff upstream.
+ For details see the <ulink url="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/">FreeBSD Porter's Handbook</ulink>.
</para>
</sect3>
</sect2>
to SourceForge, and go through the release steps. The upload
is done via FTP:
</para>
- <para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
- </para>
<para>
Or use the <command>make</command> targets as described above.
</para>
<title>After the Release</title>
<para>
When all (or: most of the) packages have been uploaded and made available,
- send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
+ send an email to the <ulink url="mailto:privoxy-announce@lists.privoxy.org">announce
mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
include the
- <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
+ <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">download
location</ulink>, 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
If you have changed anything in the stable-branch documentation source
SGML files, do:
</para>
- <para>
<programlisting>
- make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
+ make dok
</programlisting>
- </para>
<para>
That will generate <filename>doc/webserver/user-manual</filename>,
<filename>doc/webserver/developer-manual</filename>,
<filename>doc/webserver/faq</filename>,
- <filename>doc/pdf/*.pdf</filename> and
<filename>doc/webserver/index.html</filename> automatically.
</para>
<para>
Next, commit any changes from the above steps to CVS. All set?
If these are docs in the stable branch, then do:
</para>
- <para>
<programlisting>
make webserver
</programlisting>
- </para>
<para>
- This will do the upload to <ulink url="http://www.privoxy.org/">the
+ This will do the upload to <ulink url="https://www.privoxy.org/">the
webserver</ulink> (www.privoxy.org) and ensure all files and directories
there are group writable.
</para>
</para>
</sect1>
- <!-- ~~~~~ New section ~~~~~ -->
- <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
-<!-- Include contacting.sgml -->
- &contacting;
-<!-- end contacting -->
- </sect1>
-
-
-<!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
-<sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
-
-<!-- Include copyright.sgml -->
- ©right;
-<!-- end -->
-
-<!-- ~~~~~ New section ~~~~~ -->
-<sect2><title>License</title>
-<!-- Include copyright.sgml: -->
- &license;
-<!-- end copyright -->
-</sect2>
-<!-- ~ End section ~ -->
-
-<!-- ~~~~~ New section ~~~~~ -->
-<sect2><title>History</title>
-<!-- Include history.sgml -->
- &history;
-<!-- end -->
-</sect2>
-
-</sect1>
-
- <!-- ~~~~~ New section ~~~~~ -->
- <sect1 id="seealso"><title>See also</title>
-<!-- Include seealso.sgml -->
- &seealso;
-<!-- end -->
-
- </sect1>
-
<!--
This program is free software; you can redistribute it
or write to the Free Software Foundation, Inc., 59
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- $Log: developer-manual.sgml,v $
- Revision 2.50 2012/05/27 15:31:24 fabiankeil
- Remove a duplicated 'the'
-
- Spotted by igor.
-
- Revision 2.49 2012/03/20 13:05:55 fabiankeil
- We use XXX not FIXME
-
- Revision 2.48 2012/03/20 13:05:39 fabiankeil
- Remove bogus section about long and short being preferable to int
-
- Revision 2.47 2012/03/20 13:05:14 fabiankeil
- Adjust whitespace in examples to be closer to our style
-
- Revision 2.46 2012/03/20 13:04:54 fabiankeil
- IJB is dead, long live Privoxy
-
- Revision 2.45 2012/03/20 13:04:41 fabiankeil
- The redhat-dok target no longer exists so there's no point documenting it
-
- Revision 2.44 2012/03/20 13:04:19 fabiankeil
- We no longer build PDFs so stop pretending
-
- Revision 2.43 2012/03/20 13:04:03 fabiankeil
- Comment out references to multiple branches
-
- We currently don't use any.
-
- Revision 2.42 2012/03/20 13:03:05 fabiankeil
- Bump copyright date
-
- Revision 2.41 2012/03/19 12:56:08 fabiankeil
- Untabify
-
- Revision 2.40 2012/03/18 15:41:49 fabiankeil
- Bump entities to 3.0.20 UNRELEASED
-
- Revision 2.39 2012/03/18 01:16:35 diem
- Brought OS X section up to date, deprecating the osxsetup module and adding a section referring to the OSXPackageBuilder module
-
- Revision 2.38 2011/12/26 17:05:40 fabiankeil
- Bump entities for 3.0.19
-
- Revision 2.37 2011/11/13 17:03:54 fabiankeil
- Bump entities for 3.0.18 stable
-
- Revision 2.36 2011/09/04 11:10:12 fabiankeil
- Ditch trailing whitespace
-
- Revision 2.35 2011/08/17 10:40:07 fabiankeil
- Update the entities.
-
- This commit is chronological out of order.
-
- Revision 2.34 2010/11/06 12:55:48 fabiankeil
- Set p-version to 3.0.17
-
- Revision 2.33 2010/02/13 17:38:27 fabiankeil
- Update entities for 3.0.16 stable.
-
- Revision 2.32 2009/11/15 14:24:12 fabiankeil
- Prepare to generate docs for 3.0.16 UNRELEASED.
-
- Revision 2.31 2009/10/10 05:48:55 fabiankeil
- Prepare for 3.0.15 beta.
-
- Revision 2.30 2009/07/18 16:24:39 fabiankeil
- Bump entities for 3.0.14 beta.
-
- Revision 2.29 2009/06/12 14:30:58 fabiankeil
- Update entities for 3.0.13 beta.
-
- Revision 2.28 2009/05/16 13:27:21 fabiankeil
- Remove CVS revision logs. TODO item #33.
-
- Revision 2.27 2009/02/19 02:20:22 hal9
- Make some links in seealso conditional. Man page is now privoxy only links.
-
- Revision 2.26 2009/02/12 16:08:26 fabiankeil
- Declare the code stable.
-
- Revision 2.25 2009/02/12 15:37:05 fabiankeil
- Update templates.
-
- Revision 2.24 2009/01/13 16:50:35 fabiankeil
- The standard.action file is gone.
-
- Revision 2.23 2008/09/26 17:02:01 fabiankeil
- - Break some more CVS substitutions in examples.
- - Remove Junkbusters reference in example header
- for new files.
-
- Revision 2.22 2008/08/30 15:37:35 fabiankeil
- Update entities.
-
- Revision 2.21 2008/08/16 08:51:28 fabiankeil
- Update version-related entities.
-
- Revision 2.20 2008/06/14 13:21:24 fabiankeil
- Prepare for the upcoming 3.0.9 beta release.
-
- Revision 2.19 2008/05/12 11:13:33 fabiankeil
- Clarify that Privoxy is licensed under GPL version 2.
-
- Revision 2.18 2008/02/04 12:14:06 fabiankeil
- Change "Edit Packages" URL to use https.
-
- Revision 2.17 2008/02/03 21:37:41 hal9
- Apply patch from Mark: s/OSX/OS X/
-
- Revision 2.16 2008/01/19 17:52:38 hal9
- Re-commit to fix various minor issues for new release.
-
- Revision 2.15 2008/01/19 15:03:05 hal9
- Doc sources tagged for 3.0.8 release.
-
- Revision 2.14 2008/01/17 01:49:51 hal9
- Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon
- enough.
-
- Revision 2.13 2007/10/30 17:59:31 fabiankeil
- - Bump p-version, p-status and copyright date.
- - Mention that the manual is out of date.
- - Don't use examples with HardToReadCamelCase after
- explaining that we actually don't like that.
- - Minor cosmetics.
-
- Revision 2.12 2006/11/14 01:57:46 hal9
- Dump all docs prior to 3.0.6 release. Various minor changes to faq and user
- manual.
-
- Revision 2.11 2006/09/26 02:36:29 hal9
- Fix broken link per bug tracker.
-
- Revision 2.10 2006/09/22 01:27:55 hal9
- Final commit of probably various minor changes here and there. Unless
- something changes this should be ready for pending release.
-
- Revision 2.9 2006/09/14 02:30:07 hal9
- Fix ijbswa cvs links. Update notes on release process, and which config files
- should be overwritten and which not.
-
- Revision 2.8 2006/08/22 23:35:01 hal9
- Fix email address, cvs URI, address branching changes and various other
- small updates.
-
- Revision 2.7 2006/07/18 14:48:50 david__schmidt
- Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
- with what was really the latest development (the v_3_0_branch branch)
-
- Revision 1.46.2.11 2002/12/11 13:12:15 hal9
- Rewrite cvs write access give-away section.
-
- Revision 1.46.2.10 2002/09/26 21:53:45 hal9
- Changes to reflect recent change in stable branch commit policy (hopefully
- clearer now).
-
- Revision 1.46.2.9 2002/09/26 01:21:40 hal9
- Porting 3.1.1 changes: more on cvs and branches, more on versions and
- releases.
-
- Revision 1.46.2.8 2002/08/17 00:16:10 hal9
- Add note on updating webserver for User-manual/CGI editor, which is version
- dependent (and different from main UM link).
-
- Revision 1.46.2.7 2002/08/14 17:29:25 hal9
- Add small notes on post-release steps, and uploading docs to webserver.
-
- Revision 1.46.2.6 2002/08/10 11:40:25 oes
- Added disclaimer about probably being out-of-date and two small hints
-
- Revision 1.46.2.5 2002/08/09 01:15:12 hal9
- Added some notes on pre-release steps (test builds first, update ChangeLog).
-
- Revision 1.46.2.4 2002/05/29 00:30:59 mal0rd
- Fixed a little formatting. Clarified debian section.
-
- Revision 1.46.2.3 2002/05/28 04:32:45 hal9
- Change hints on bundling index.html to privoxy-index.html
-
- Revision 1.46.2.2 2002/05/26 17:04:24 hal9
- -Spellcheck, very minor edits, and sync across branches
-
- Revision 1.48 2002/05/26 12:48:31 roro
- Add releasing information about Debian.
-
- Revision 1.47 2002/05/26 04:55:11 mal0rd
- Added debian-dist and debian-upload targets. Also documented usage.
-
- Revision 1.46 2002/05/22 17:15:00 oes
- Updated intro
-
- Revision 1.45 2002/05/19 23:01:54 hal9
- Add small section on general packaging guidelines (e.g. actions files must
- be writable).
-
- Revision 1.44 2002/05/15 03:55:17 hal9
- Fix ulink -> link, and minor modification to release process section for
- clarification.
-
- Revision 1.43 2002/05/10 01:48:19 hal9
- This is mostly proposed copyright/licensing additions and changes. Docs
- are still GPL, but licensing and copyright are more visible. Also, copyright
- changed in doc header comments (eliminate references to JB except FAQ).
-
- Revision 1.42 2002/05/05 20:26:02 hal9
- Sorting out license vs copyright in these docs.
-
- Revision 1.41 2002/05/04 08:44:44 swa
- bumped version
-
- Revision 1.40 2002/05/04 00:43:43 hal9
- -Remove TOC/first page kludge with proper stylesheet fix.
- -Combined the two very brief sections: Intro and Quickstart.
-
- Revision 1.39 2002/05/02 15:08:25 oes
- Added explanation about version numbers and RPM package revisions
-
- Revision 1.38 2002/04/29 02:20:31 hal9
- Add info on steps for uploading and the release process on SF.
-
- Revision 1.37 2002/04/26 17:23:29 swa
- bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
-
- Revision 1.36 2002/04/26 05:25:23 hal9
- Mass commit to catch a few scattered fixes.
-
- Revision 1.35 2002/04/17 15:16:15 oes
- Added link to docbook crash course
-
- Revision 1.34 2002/04/15 23:39:32 oes
- - Extended & fixed the release section
- - Added CVS guideline sections
- - Separated webserver section from release section
- - Commented out boilerplate inclusion (If you don't know yet what it is,
- you shouldn't mess with its code ;-)
- - Nits & fixes
-
- Revision 1.33 2002/04/12 03:49:53 hal9
- Spell checked. Clarification on where docs are kept.
-
- Revision 1.32 2002/04/11 21:29:58 jongfoster
- Documenting Win32 release procedure
-
- Revision 1.31 2002/04/11 09:32:52 oes
- more nits
-
- Revision 1.30 2002/04/11 09:24:53 oes
- nits
-
- Revision 1.29 2002/04/10 18:45:14 swa
- generated
-
- Revision 1.28 2002/04/08 22:59:26 hal9
- Version update. Spell chkconfig correctly :)
-
- Revision 1.27 2002/04/08 15:31:18 hal9
- Touch ups to documentation section.
-
- Revision 1.26 2002/04/07 23:50:08 hal9
- Documentation changes to reflect HTML docs now in CVS, and new generated files
- list.
-
- Revision 1.25 2002/04/06 05:07:28 hal9
- -Add privoxy-man-page.sgml, for man page.
- -Add authors.sgml for AUTHORS (and p-authors.sgml)
- -Reworked various aspects of various docs.
- -Added additional comments to sub-docs.
-
- Revision 1.24 2002/04/04 21:33:37 hal9
- More on documenting the documents.
-
- Revision 1.23 2002/04/04 18:46:47 swa
- consistent look. reuse of copyright, history et. al.
-
- Revision 1.22 2002/04/04 17:27:56 swa
- more single file to be included at multiple points. make maintaining easier
-
- Revision 1.21 2002/04/04 06:48:37 hal9
- Structural changes to allow for conditional inclusion/exclusion of content
- based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
- definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
- eventually be set by Makefile.
- More boilerplate text for use across multiple docs.
-
- Revision 1.20 2002/04/04 03:28:27 david__schmidt
- Add Mac OS X section
-
- Revision 1.19 2002/04/03 15:09:42 david__schmidt
- Add OS/2 build section
-
- Revision 1.18 2002/04/03 03:51:48 hal9
- Touch ups.
-
- Revision 1.17 2002/04/03 01:21:17 hal9
- Implementing Andreas's suggestions for Release sections.
-
- Revision 1.16 2002/03/31 23:04:40 hal9
- Fleshed out the doc section, and added something for an intro so it was not
- blank.
-
- Revision 1.15 2002/03/30 22:29:47 swa
- wrong make flavour
-
- Revision 1.14 2002/03/30 19:04:08 swa
- people release differently. no good.
- I want to make parts of the docs only.
-
- Revision 1.13 2002/03/27 01:16:41 hal9
- ditto
-
- Revision 1.12 2002/03/27 01:02:51 hal9
- Touch up on name change...
-
- Revision 1.11 2002/03/26 22:29:55 swa
- we have a new homepage!
-
- Revision 1.10 2002/03/24 12:33:01 swa
- more additions.
-
- Revision 1.9 2002/03/24 11:01:05 swa
- name change
-
- Revision 1.8 2002/03/23 15:13:11 swa
- renamed every reference to the old name with foobar.
- fixed "application foobar application" tag, fixed
- "the foobar" with "foobar". left junkbustser in cvs
- comments and remarks to history untouched.
-
- Revision 1.7 2002/03/11 13:13:27 swa
- correct feedback channels
-
- Revision 1.6 2002/02/24 14:25:06 jongfoster
- Formatting changes. Now changing the doctype to DocBook XML 4.1
- will work - no other changes are needed.
-
- Revision 1.5 2001/10/31 18:16:51 swa
- documentation added: howto generate docs in text and html
- format, howto move stuff to the webserver.
-
- Revision 1.4 2001/09/23 10:13:48 swa
- upload process established. run make webserver and
- the documentation is moved to the webserver. documents
- are now linked correctly.
-
- Revision 1.3 2001/09/13 15:27:40 swa
- cosmetics
-
- Revision 1.2 2001/09/13 15:20:17 swa
- merged standards into developer manual
-
- Revision 1.1 2001/09/12 15:36:41 swa
- source files for junkbuster documentation
-
- Revision 1.3 2001/09/10 17:43:59 swa
- first proposal of a structure.
-
- Revision 1.2 2001/06/13 14:28:31 swa
- docs should have an author.
-
- Revision 1.1 2001/06/13 14:20:37 swa
- first import of project's documentation for the webserver.
-
-->
</article>
projects / privoxy.git / blobdiff