From 2b20227c4761fe24a75b65620d9469b6290cc7f5 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Tue, 15 Dec 2020 08:32:29 +0100 Subject: [PATCH] Regenerate developer-manual --- doc/webserver/developer-manual/index.html | 10 +- .../developer-manual/newrelease.html | 163 +++--------------- 2 files changed, 30 insertions(+), 143 deletions(-) diff --git a/doc/webserver/developer-manual/index.html b/doc/webserver/developer-manual/index.html index e504f74a..6b436b72 100644 --- a/doc/webserver/developer-manual/index.html +++ b/doc/webserver/developer-manual/index.html @@ -153,12 +153,10 @@
6.3.1. Note on Privoxy Packaging
6.3.2. Source Tarball
-
6.3.3. SuSE, Conectiva or Red Hat RPM
-
6.3.4. Solaris
-
6.3.5. Windows
-
6.3.6. Debian
-
6.3.7. Mac OS X
-
6.3.8. FreeBSD
+
6.3.3. Windows
+
6.3.4. Debian
+
6.3.5. Mac OS X
+
6.3.6. FreeBSD
6.4. Uploading and Releasing Your Package
diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html index 6d630d2a..d8a91e46 100644 --- a/doc/webserver/developer-manual/newrelease.html +++ b/doc/webserver/developer-manual/newrelease.html @@ -130,7 +130,7 @@ for-privoxy-version=3.0.11 
  $ git tag
   #   to see the tags
-  $ git log [last release tag]..HEAD > /tmp/log
+  $ 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
@@ -198,11 +198,11 @@ for-privoxy-version=3.0.11 fresh version should be uploaded to the webserver (this is in addition to the main User Manual link from the main page since we need to keep manuals for various versions available). The CGI pages will link to something like https://www.privoxy.org/$(VERSION)/user-manual/. - 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.

+ This needs to be updated for each new release and is done with the "webserver" + target.

  • -

    Tag all files in Git with the version number with "git tag +

    Tag all files in Git with the version number with "git tag -s v_X_Y_Z". Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.

  • @@ -308,8 +308,7 @@ for-privoxy-version=3.0.11

    Also suggested: Developer Manual (doc/webserver/developer-manual) and ChangeLog (top-level directory). FAQ and the manuals - are HTML docs. There are also text versions in doc/text/ which could conceivably - also be included.

    + are HTML docs.

    The documentation has been designed such that the manuals are linked to each other from parallel directories, and should be packaged that way. privoxy-index.html can also be included and can serve as a focal point for docs and other links of interest (and possibly renamed to @@ -327,10 +326,11 @@ for-privoxy-version=3.0.11 should be left in tact as well.

  • -

    Other configuration files (default.action and default.filter) 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.

    +

    Other configuration files (default.action, regression-tests.action and default.filter) 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.

  • Please check platform specific notes in this doc, if you haven't done

    6.3.2. Source Tarball

    First, make sure that you have freshly exported the right version - into an empty directory. (See "Building and releasing packages" above). Then run:

    + into an empty directory. (See "Building and releasing packages" above). Then run from that + directory:

    - 
      cd current
-  autoheader && autoconf && ./configure
    + 
      autoheader && autoconf && ./configure
    @@ -365,95 +365,9 @@ for-privoxy-version=3.0.11 -

    To upload the package to Sourceforge, simply issue

    - - - - -
    - 
      make tarball-upload
    -
    -

    Go to the displayed URL and release the file publicly on Sourceforge. For the change log field, use the - relevant section of the ChangeLog file.

    -
    -
    -

    6.3.3. SuSE, Conectiva or Red Hat RPM

    -

    In following text, replace dist with either "rh" for Red Hat or "suse" for SuSE.

    -

    First, make sure that you have freshly exported the right version - into an empty directory. (See "Building and releasing packages" above).

    -

    As the only exception to not changing anything after export from Git, now examine the file privoxy-dist.spec and make sure - that the version information and the RPM release number are correct. The RPM release numbers for each version - start at one. Hence it must be reset to one if this is the first RPM for dist which is built from version X.Y.Z. Check the file list if unsure. Else, it must be set to - the highest already available RPM release number for that version plus one.

    -

    Then run:

    - - - - -
    - 
      cd current
-  autoheader && autoconf && ./configure
    -
    -

    Then do

    - - - - -
    - 
      make dist-dist
    -
    -

    To upload the package to Sourceforge, simply issue

    - - - - -
    - 
      make dist-upload rpm_packagerev
    -
    -

    where rpm_packagerev is the RPM release number as determined above. Go - to the displayed URL and release the file publicly on Sourceforge. Use the release notes and change log from - the source tarball package.

    -
    -
    -

    6.3.4. Solaris

    -

    Login to Sourceforge's compilefarm via ssh:

    - - - - -
    - 
      ssh cf.sourceforge.net
    -
    -

    Choose the right operating system (not the Debian one). When logged in, make sure that you have freshly exported the right version into an empty directory. (See - "Building and releasing packages" above). Then run:

    - - - - -
    - 
      cd current
-  autoheader && autoconf && ./configure
    -
    -

    Then run

    - - - - -
    - 
      gmake solaris-dist
    -
    -

    which creates a gzip'ed tar archive. Sadly, you cannot use make solaris-upload 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.

    -

    6.3.5. Windows

    +

    6.3.3. Windows

    Note that the docbook generated files might need some hand editing, so the Windows build makefile does not rebuild the docs.

    First, make sure that you have freshly exported the right version @@ -486,7 +400,7 @@ for-privoxy-version=3.0.11 package.

    -

    6.3.6. Debian

    +

    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:

    @@ -505,24 +419,17 @@ for-privoxy-version=3.0.11 -

    This will create ../privoxy_3.0.30-UNRELEASED-1_i386.deb which can be uploaded. To - upload the package to Sourceforge, simply issue

    - - - - -
    - 
      make debian-upload
    -
    +

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

    -

    6.3.7. Mac OS X

    +

    6.3.5. Mac OS X

    First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above).

    There are three modules available in the CVS repository backups for use on Mac OS X, though technically only two of them generate a release (the other can be used to install from source).

    -

    6.3.7.1. +

    6.3.5.1. OSXPackageBuilder module (Documentation out of date)

    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:

    @@ -542,7 +449,7 @@ for-privoxy-version=3.0.11 makes it clear which package is for whichversion of OS X.

    -

    6.3.7.2. osxsetup module +

    6.3.5.2. osxsetup module (DEPRECATED) (Documentation out of date)

    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 @@ -584,7 +491,7 @@ for-privoxy-version=3.0.11 package supports.

    -

    6.3.7.3. macsetup module +

    6.3.5.3. macsetup module (Documentation out of date)

    The macsetup module is ideal if you wish to build and install Privoxy from source on a single machine.

    Check out the module from CVS as follows into a folder parallel to the exported privoxy source:

    @@ -601,7 +508,7 @@ for-privoxy-version=3.0.11

    -

    6.3.8. FreeBSD

    +

    6.3.6. FreeBSD

    Update the www/privoxy port and submit a diff upstream. For details see the FreeBSD Porter's Handbook.

    @@ -609,26 +516,8 @@ for-privoxy-version=3.0.11

    6.4. Uploading and Releasing Your Package

    -

    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:

    - -

    Or use the make targets as described above.

    -

    Once this done go to https://sourceforge.net/project/admin/editpackages.php?group_id=11118, making sure you are logged in. - Find your target platform in the second column, and click Add Release. You will then - need to create a new release for your package, using the format of $VERSION - ($CODE_STATUS), e.g. 3.0.30 (beta).

    +

    After the package is ready, it is time to upload it and go through the release steps. The upload is done at + SourceForge after logging in.

    Now just follow the prompts. Be sure to add any appropriate Release notes. You should see your freshly uploaded packages in "Step 2. Add Files To This Release". Check the appropriate box(es). Remember at each step to hit the "Refresh/Submit" buttons! You should now see @@ -642,8 +531,8 @@ for-privoxy-version=3.0.11

    6.5. After the Release

    When all (or: most of the) packages have been uploaded and made available, send an email to the announce mailing list, Subject: "Version X.Y.Z - available for download". Be sure to include the announce mailing list, Subject: "Announcing Privoxy + X.Y.Z $CODE_STATUS". Be sure to include the download location, 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.

    -- 2.39.2