From 1f8e678f82936f21347922e1b2428ac00cd4d34e Mon Sep 17 00:00:00 2001 From: Lee Date: Fri, 10 Aug 2018 14:18:09 -0400 Subject: [PATCH] rebuild the docs --- doc/webserver/developer-manual/coding.html | 8 +- .../developer-manual/documentation.html | 18 ++--- .../developer-manual/{cvs.html => git.html} | 80 +++++++++---------- doc/webserver/developer-manual/index.html | 16 ++-- .../developer-manual/introduction.html | 20 ++--- .../developer-manual/newrelease.html | 32 ++++---- .../developer-manual/webserver-update.html | 4 +- 7 files changed, 88 insertions(+), 90 deletions(-) rename doc/webserver/developer-manual/{cvs.html => git.html} (74%) diff --git a/doc/webserver/developer-manual/coding.html b/doc/webserver/developer-manual/coding.html index b82c4b67..3e2753ed 100644 --- a/doc/webserver/developer-manual/coding.html +++ b/doc/webserver/developer-manual/coding.html @@ -2290,10 +2290,9 @@ WIDTH="100%" >
const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
-/*********************************************************************
+>/*********************************************************************
  *
- * File        :  $S<!-- Break CVS Substitution -->ource$
+ * File        :  $Source
  *
  * Purpose     :  (Fill me in with a good description!)
  *
@@ -2371,10 +2370,9 @@ WIDTH="100%"
 CLASS="PROGRAMLISTING"
 >#ifndef _FILENAME_H
 #define _FILENAME_H
-#define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
 /*********************************************************************
  *
- * File        :  $S<!-- Break CVS Substitution -->ource$
+ * File        :  $Source
  *
  * Purpose     :  (Fill me in with a good description!)
  *
diff --git a/doc/webserver/developer-manual/documentation.html b/doc/webserver/developer-manual/documentation.html
index bf25e6c2..b8d53484 100644
--- a/doc/webserver/developer-manual/documentation.html
+++ b/doc/webserver/developer-manual/documentation.html
@@ -10,8 +10,8 @@ REL="HOME"
 TITLE="Privoxy Developer Manual"
 HREF="index.html">Prev

Packagers are encouraged to include this documentation. For those without the ability to build the docs locally, text versions of each are kept in - CVS. HTML versions are also being kept in CVS under + Git. HTML versions are also being kept in Git under doc/webserver/*

Documentation writers should please make sure documents build - successfully before committing to CVS, if possible. + successfully before committing to Git, if possible.

How do you update the webserver (i.e. the pages on privoxy.org)? @@ -255,7 +255,7 @@ CLASS="COMPUTEROUTPUT" >

Finished docs should be occasionally submitted to CVS +> Finished docs should be occasionally submitted to Git (doc/webserver/*/*.html

3.3. Privoxy Custom Entities

PrevThe CVS RepositoryThe Git RepositoryThe CVS RepositoryThe Git Repository

2. The CVS Repository2. The Git Repository

If you become part of the active development team, you will eventually - need write access to our holy grail, the CVS repository. One of the + need write access to our holy grail, the Git repository. One of the team members will need to set this up for you. Please read - this chapter completely before accessing via CVS. + this chapter completely before accessing via Git.

2.1. Access to CVS2.1. Access to Git

The project's CVS repository is hosted on +> The project's Git repository is hosted at the SourceForge.Privoxy site. - For historical reasons, the CVS server is - called ijbswa.cvs.sourceforge.net, the repository is - called ssh://git@git.privoxy.org:23/git/privoxy.git, + the central repository is called ijbswa, and the source tree module is called - privoxy, and the + source branch is called current. +>master. Subfolders exist + within the project for target-dependent build and packaging tools, each + including the name of the target operating system in their name (e.g. + Windows, OSXPackageBuilder, debian). There is a webview of the Git + hierarchy at + https://www.privoxy.org/gitweb/?p=privoxy.git;a=tree, + which might help with visualizing how these pieces fit together.

2.2. Branches

Within the CVS repository, there are modules and branches. As - mentioned, the sources are in the current - "module". Other modules are present for platform specific - issues. There is a webview of the CVS hierarchy at http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/, - which might help with visualizing how these pieces fit together. +> Whilst the central repository contains only the master branch, developers + are of course free to create branches in their local repositories as they + develop features, fixes, or update the target-dependent tools. Only once + such changes are fully tested ought they be pushed back to the central + repository master branch.

At one time there were two distinct branches: stable and unstable. The @@ -152,13 +152,13 @@ CLASS="SECT2" >

2.3. CVS Commit Guidelines2.3. Git Commit Guidelines

The source tree is the heart of every software project. Every effort must be made to ensure that it is readable, compilable and consistent at all - times. We expect anyone with CVS access to strictly + times. We expect anyone with Git access to strictly adhere to the following guidelines:

  • Before changing things on CVS, make sure that your changes are in line +> Before changing things on Git, make sure that your changes are in line with the team's general consensus on what should be done.

  • 2. The CVS RepositoryThe Git Repository
    2.1. Access to CVSAccess to Git
    2.2. Branches
    2.3. CVS Commit GuidelinesGit Commit Guidelines
    3.3. Privoxy Custom Entities
    Nextprivoxy-devel mailing list. - You can submit your ideas, or even better patches. Patches are best + 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.

    You will also need to have a cvs package installed, which will - entail having ssh installed as well (which seems to be a requirement of - SourceForge), in order to access the cvs repository. Having the GNU build - tools is also going to be important (particularly, autoconf and gmake). +> You will also need to have a git package installed, which will + entail having ssh installed as well, in order to access the git repository. + Having the GNU build tools is also going to be important (particularly, + autoconf and gmake).

    For the time being (read, this section is under construction), you can @@ -170,7 +170,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" >NextThe CVS RepositoryThe Git Repository

    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 + while the odd ones denote the evolving state of the sources on Git in between. + It follows that Z is odd on Git 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. + This ensures that builds from Git snapshots are easily distinguished from released versions. The point version is reset to zero when the minor changes.

    In summary, the main CVS trunk is the development branch where new +> 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 @@ -225,7 +225,7 @@ CLASS="EMPHASIS" >

    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 CVS. If you + 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,

  • All documentation should be rebuild after the version bump. - Finished docs should be then be committed to CVS (for those + 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. , 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 + should all also be committed to Git for other packagers. The formal docs should be uploaded to the webserver. See the Section "Updating the webserver" in this manual for details.

  • Tag all files in CVS with the version number with +> Tag all files in Git with the version number with "you must make sure that you build from clean sources by exporting - the right version from CVS into an empty directory (just press return when asked for a password): @@ -473,7 +473,7 @@ CLASS="EMPHASIS" >Do NOT change 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.

    ). 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 CVS as + this, it is in Git as doc/webserver/man-page/privoxy-man-page.html

    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 privoxy-

    There are three modules available in the CVS repository for use on Mac +> 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).

    The OSXPackageBuilder module generates OS X installer packages - supporting all Macs running OS X 10.4 and above. Obtain it from CVS as + 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:

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

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

    ". (This is a separate target due to dependencies on some obscure perl scripts - [now in CVS, but not well tested]. See comments in GNUmakefile.) @@ -143,7 +143,7 @@ CLASS="FILENAME" >).

    Next, commit any changes from the above steps to CVS. All set? +> Next, commit any changes from the above steps to Git. All set? If these are docs in the stable branch, then do: