From 65690f437fa5f89034b8e788f10eba449a5312e5 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Wed, 20 Jan 2021 16:18:51 +0100 Subject: [PATCH] Rebuild docs --- INSTALL | 4 +- README | 21 +- .../developer-manual/newrelease.html | 205 +++++++----------- doc/webserver/index.html | 2 +- doc/webserver/user-manual/appendix.html | 16 +- doc/webserver/user-manual/configuration.html | 8 +- doc/webserver/user-manual/installation.html | 4 +- doc/webserver/user-manual/introduction.html | 13 +- doc/webserver/user-manual/quickstart.html | 2 +- doc/webserver/user-manual/startup.html | 4 +- 10 files changed, 111 insertions(+), 168 deletions(-) diff --git a/INSTALL b/INSTALL index 8e3c92f3..1e6df14e 100644 --- a/INSTALL +++ b/INSTALL @@ -39,8 +39,8 @@ compiler like gcc are required. When building from a source tarball, first unpack the source: - tar xzvf privoxy-3.0.30-beta-src.tar.gz - cd privoxy-3.0.30-beta + tar xzvf privoxy-3.0.30-stable-src.tar.gz + cd privoxy-3.0.30-stable To build the development version, you can get the source code by doing: diff --git a/README b/README index 14cb53c4..acd40a99 100644 --- a/README +++ b/README @@ -32,9 +32,8 @@ * *********************************************************************/ -This README is included with the development version of Privoxy 3.0.30. See -https://www.privoxy.org/ for more information. The current code maturity level -is "UNRELEASED", but seems stable to us :). +This README is included with Privoxy 3.0.30. See https://www.privoxy.org/ for +more information. The current code maturity level is "stable". ------------------------------------------------------------------------------- @@ -105,22 +104,16 @@ try it with FTP or other protocols for the simple reason it does not work. The actions list can be configured via the web interface accessed via http:// p.p/, as well other options. -All configuration files are subject to unannounced changes during the -development process. - ------------------------------------------------------------------------------- 5. DOCUMENTATION -There should be documentation in the 'doc' subdirectory, but it may not be -completed at this point. In particular, see the User Manual there, the FAQ, and -those interested in Privoxy development, should look at developer-manual. +There should be documentation in the 'doc' subdirectory. In particular, see the +User Manual there, the FAQ, and those interested in Privoxy development, should +look at developer-manual. -The most up to date source of information on the current development version, -may still be either comments in the source code, or the included configuration -files. The source and configuration files are all well commented. The main -configuration files are: 'config', 'default.action', and 'default.filter' in -the top-level source directory. +The source and configuration files are all well commented. The main +configuration files are: 'config', 'default.action', and 'default.filter'. Included documentation may vary according to platform and packager. All documentation is posted on https://www.privoxy.org, in case you don't have it, diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html index e49d9a57..117bf1a0 100644 --- a/doc/webserver/developer-manual/newrelease.html +++ b/doc/webserver/developer-manual/newrelease.html @@ -401,34 +401,12 @@ for-privoxy-version=3.0.11

6.3.4. Debian

-

First, make sure that you have freshly exported the right version - into an empty directory. (See "Building and releasing packages" above). Then add a log entry to - debian/changelog, if it is not already there, for example by running (from the debian - directory):

- - - - -
- 
  debchange -v 3.0.30-UNRELEASED-1 "New upstream version"
-
-

Then, run (from the root directory):

- - - - -
- 
  dpkg-buildpackage -rfakeroot -us -uc -b
-
-

This will create ../privoxy_3.0.30-UNRELEASED-1_i386.deb which can be - uploaded.

Using git-buildpackage we start with a clone of the last Debian version:

- 
        gbp clone https://salsa.debian.org/debian/privoxy.git
-        cd privoxy
-
+ 
  gbp clone https://salsa.debian.org/debian/privoxy.git
+  cd privoxy
@@ -436,9 +414,8 @@ for-privoxy-version=3.0.11
- 
        cd privoxy
-        gbp pull
-
+ 
  cd privoxy
+  gbp pull
@@ -446,8 +423,7 @@ for-privoxy-version=3.0.11
- 
        gbp import-orig --uscan
-
+ 
  gbp import-orig --uscan
@@ -455,8 +431,7 @@ for-privoxy-version=3.0.11
- 
        while quilt push; do quilt refresh; done
-
+ 
  while quilt push; do quilt refresh; done
@@ -464,9 +439,8 @@ for-privoxy-version=3.0.11
- 
        quilt delete XX_patchname.patch
-        git rm debian/patches/XX_patchname.patch
-
+ 
  quilt delete XX_patchname.patch
+  git rm debian/patches/XX_patchname.patch
@@ -474,10 +448,9 @@ for-privoxy-version=3.0.11
- 
        quilt push -f
-        quilt edit some_file
-        quilt refresh
-
+ 
  quilt push -f
+  quilt edit some_file
+  quilt refresh
@@ -485,8 +458,7 @@ for-privoxy-version=3.0.11
- 
        while quilt push; do quilt refresh; done
-
+ 
  while quilt push; do quilt refresh; done
@@ -494,8 +466,7 @@ for-privoxy-version=3.0.11
- 
        quilt pop -a
-
+ 
  quilt pop -a
@@ -503,8 +474,7 @@ for-privoxy-version=3.0.11
- 
        dch -v 3.0.30-1
-
+ 
  dch -v 3.0.30-1
@@ -513,8 +483,7 @@ for-privoxy-version=3.0.11
- 
        gbp buildpackage -us -uc
-
+ 
  gbp buildpackage -us -uc
@@ -522,8 +491,7 @@ for-privoxy-version=3.0.11
- 
        lintian -iI ../build-area/privoxy_3.0.30-1_amd64.changes
-
+ 
  lintian -iI ../build-area/privoxy_3.0.30-1_amd64.changes
@@ -532,8 +500,7 @@ for-privoxy-version=3.0.11 
        sudo cowbuilder --build --basepath /var/cache/pbuilder/base.cow ../build-area/privoxy_3.0.30-1.dsc
-
+ "PROGRAMLISTING"> sudo cowbuilder --build --basepath /var/cache/pbuilder/base.cow ../build-area/privoxy_3.0.30-1.dsc @@ -542,8 +509,7 @@ for-privoxy-version=3.0.11 
        autopkgtest /var/cache/pbuilder/result/privoxy_3.0.30-1_amd64.changes -s -- schroot sid
-
+ "PROGRAMLISTING"> autopkgtest /var/cache/pbuilder/result/privoxy_3.0.30-1_amd64.changes -s -- schroot sid @@ -554,82 +520,77 @@ for-privoxy-version=3.0.11
- 
        gpg --detach-sign --armor privoxy_3.0.30-1_i386.deb
-        gpg --detach-sign --armor privoxy_3.0.30-1_amd64.deb
-
+ 
  gpg --detach-sign --armor privoxy_3.0.30-1_i386.deb
+  gpg --detach-sign --armor privoxy_3.0.30-1_amd64.deb

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/

-

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:

- - - - -
- 
        sudo apt install build-essential devscripts
-        sudo apt-get build-dep privoxy
-
-
-

After this enter the checked out privoxy git tree and check that all (new) build dependencies are met:

- - - - -
- 
        dpkg-checkbuilddeps
-
-
-

If something is missing, just add it using

- - - - -
- 
        sudo apt install foobar
-
-
-

Now you may update debian/changelog, especially the version number using

- - - - -
- 
        dch
-
-
-

and finally build the package:

- - - - -
- 
        debuild -us -uc -b
-
-
-

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

- - - - -
- 
        debian/rules clean
-
-
-

And maybe repair some artefacts using one or both of the following commands:

- - - - -
- 
        git reset --hard
-        git clean -fd
-
-
+
+

6.3.4.1. Debian GIT Snapshot

+

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:

+ + + + +
+ 
  sudo apt install build-essential devscripts
+  sudo apt-get build-dep privoxy
+
+

After this enter the checked out privoxy git tree and check that all (new) build dependencies are met:

+ + + + +
+ 
  dpkg-checkbuilddeps
+
+

If something is missing, just add it using

+ + + + +
+ 
  sudo apt install foobar
+
+

Now you may update debian/changelog, especially the version number using

+ + + + +
+ 
  dch
+
+

and finally build the package:

+ + + + +
+ 
  debuild -us -uc -b
+
+

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

+ + + + +
+ 
  debian/rules clean
+
+

And maybe repair some artefacts using one or both of the following commands:

+ + + + +
+ 
  git reset --hard
+  git clean -fd
+
+

6.3.5. Mac OS X

diff --git a/doc/webserver/index.html b/doc/webserver/index.html index b48ad6bf..bacb0b5c 100644 --- a/doc/webserver/index.html +++ b/doc/webserver/index.html @@ -32,7 +32,7 @@

https://www.privoxy.org/donate

-

The most recent release is 3.0.30 (UNRELEASED).

+

The most recent release is 3.0.30 (stable).

diff --git a/doc/webserver/user-manual/appendix.html b/doc/webserver/user-manual/appendix.html index aed42cdc..c5508209 100644 --- a/doc/webserver/user-manual/appendix.html +++ b/doc/webserver/user-manual/appendix.html @@ -202,7 +202,7 @@ these. If not, you will get a friendly error message. Internet access is not necessary either.