current/doc/webserver/developer-manual coding.html, 1.65, 1.66 cvs.html, 1.26, 1.27 documentation.html, 1.46, 1.47 index.html, 1.86, 1.87 introduction.html, 1.17, 1.18 newrelease.html, 1.62, 1.63 testing.html, 1.24, 1.25 webserver-update.html, 1.17, 1.18
Fabian Keil <[email protected]> Thu, 12 Jan 2017 14:27:49 +0000
| Newsgroups | gmane.comp.web.privoxy.cvs |
|---|---|
| Message-ID | <[email protected]> |
Update of /cvsroot/ijbswa/current/doc/webserver/developer-manual
In directory sfp-cvs-1.v30.ch3.sourceforge.com:/tmp/cvs-serv24265/doc/webserver/developer-manual
Modified Files:
coding.html cvs.html documentation.html index.html
introduction.html newrelease.html testing.html
webserver-update.html
Log Message:
Regenerate HTML docs with recent changes
configure.in has been locally reverted to r1.204
to get 3.0.26 stable documentation that can be put
on the webserver before the next release.
Tidied with tidy 5.2.0 from http://www.html-tidy.org/.
As an expected side effect the diff is bloated enough
to be considered a "rewrite" by git (again), but using
a more recent tidy version should make it easier to
prevent frequent diff bloat in the future when building
on different platforms.
As an unexpected side-effect some pre tags are messed
up now and their first line contains bogus white-space
that causes rendering issues. This regression should
be analysed and fixed or worked around before the next
release but doesn't seem critical.
It's conceivable that the tidy upgrade caused less
obvious regressions that have yet to be found.
Index: index.html
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/index.html,v
retrieving revision 1.86
retrieving revision 1.87
diff -C2 -d -r1.86 -r1.87
*** index.html 26 Aug 2016 12:32:48 -0000 1.86
--- index.html 12 Jan 2017 14:27:46 -0000 1.87
***************
*** 1,422 ****
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
! Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>
! Privoxy Developer Manual
! </title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="NEXT" title="Introduction" href="introduction.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
! </head>
! <body class="ARTICLE" bgcolor="#EEEEEE" text="#000000" link="#0000FF"
! vlink="#840084" alink="#0000FF">
! <div class="ARTICLE">
! <div class="TITLEPAGE">
! <h1 class="TITLE">
! <a name="AEN2">Privoxy Developer Manual</a>
! </h1>
! <p class="PUBDATE">
! <sub><a href="https://www.privoxy.org/user-manual/copyright.html"
! target="_top">Copyright</a> © 2001-2016 by <a href=
! "https://www.privoxy.org/" target="_top">Privoxy
! Developers</a></sub><br>
! </p>
! <p class="PUBDATE">
! $Id: developer-manual.sgml,v 2.78 2016/08/25 19:53:28 ler762 Exp
! $<br>
! </p>
! <div>
! <div class="ABSTRACT">
! <a name="AEN9"></a>
! <p>
! The developer manual provides guidance on coding, testing,
! packaging, documentation and other issues of importance to
! those involved with <span class="APPLICATION">Privoxy</span>
! development. It is mandatory (and helpful!) reading for anyone
! who wants to join the team. Note that it's currently out of
! date and may not be entirely correct. As always, patches are
! welcome.
! </p>
! <p>
! Please note that this document is constantly evolving. This
! copy represents the state at the release of version 3.0.26. You
! can find the latest version of the this manual at <a href=
! "https://www.privoxy.org/developer-manual/" target=
! "_top">https://www.privoxy.org/developer-manual/</a>. Please
! have a look at the <a href=
! "https://www.privoxy.org/user-manual/contact.html" target=
! "_top">contact section in the user manual</a> if you are
! interested in contacting the developers.
! </p>
! </div>
</div>
- <hr>
- </div>
- <div class="TOC">
- <dl>
- <dt>
- <b>Table of Contents</b>
- </dt>
- <dt>
- 1. <a href="introduction.html">Introduction</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 1.1. <a href="introduction.html#QUICKSTART">Quickstart to
- Privoxy Development</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 2. <a href="cvs.html">The CVS Repository</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 2.1. <a href="cvs.html#CVSACCESS">Access to CVS</a>
- </dt>
- <dt>
- 2.2. <a href="cvs.html#CVSBRANCHES">Branches</a>
- </dt>
- <dt>
- 2.3. <a href="cvs.html#CVSCOMMIT">CVS Commit Guidelines</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 3. <a href="documentation.html">Documentation Guidelines</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 3.1. <a href="documentation.html#SGML">Quickstart to Docbook
- and SGML</a>
- </dt>
- <dt>
- 3.2. <a href="documentation.html#DOCSTYLE"><span class=
- "APPLICATION">Privoxy</span> Documentation Style</a>
- </dt>
- <dt>
- 3.3. <a href="documentation.html#AEN207">Privoxy Custom
- Entities</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 4. <a href="coding.html">Coding Guidelines</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 4.1. <a href="coding.html#S1">Introduction</a>
- </dt>
- <dt>
- 4.2. <a href="coding.html#S2">Using Comments</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 4.2.1. <a href="coding.html#S3">Comment, Comment,
- Comment</a>
- </dt>
- <dt>
- 4.2.2. <a href="coding.html#S4">Use blocks for
- comments</a>
- </dt>
- <dt>
- 4.2.3. <a href="coding.html#S5">Keep Comments on their
- own line</a>
- </dt>
- <dt>
- 4.2.4. <a href="coding.html#S6">Comment each logical
- step</a>
- </dt>
- <dt>
- 4.2.5. <a href="coding.html#S7">Comment All Functions
- Thoroughly</a>
- </dt>
- <dt>
- 4.2.6. <a href="coding.html#S8">Comment at the end of
- braces if the content is more than one screen length</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 4.3. <a href="coding.html#S9">Naming Conventions</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 4.3.1. <a href="coding.html#S10">Variable Names</a>
- </dt>
- <dt>
- 4.3.2. <a href="coding.html#S11">Function Names</a>
- </dt>
- <dt>
- 4.3.3. <a href="coding.html#S12">Header file
- prototypes</a>
- </dt>
- <dt>
- 4.3.4. <a href="coding.html#S13">Enumerations, and
- #defines</a>
- </dt>
- <dt>
- 4.3.5. <a href="coding.html#S14">Constants</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 4.4. <a href="coding.html#S15">Using Space</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 4.4.1. <a href="coding.html#S16">Put braces on a line by
- themselves.</a>
- </dt>
- <dt>
- 4.4.2. <a href="coding.html#S17">ALL control statements
- should have a block</a>
- </dt>
- <dt>
- 4.4.3. <a href="coding.html#S18">Do not belabor/blow-up
- boolean expressions</a>
- </dt>
- <dt>
- 4.4.4. <a href="coding.html#S19">Use white space freely
- because it is free</a>
- </dt>
- <dt>
- 4.4.5. <a href="coding.html#S20">Don't use white space
- around structure operators</a>
- </dt>
- <dt>
- 4.4.6. <a href="coding.html#S21">Make the last brace of a
- function stand out</a>
- </dt>
- <dt>
- 4.4.7. <a href="coding.html#S22">Use 3 character
- indentions</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 4.5. <a href="coding.html#S23">Initializing</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 4.5.1. <a href="coding.html#S24">Initialize all
- variables</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 4.6. <a href="coding.html#S25">Functions</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 4.6.1. <a href="coding.html#S26">Name functions that
- return a boolean as a question.</a>
- </dt>
- <dt>
- 4.6.2. <a href="coding.html#S27">Always specify a return
- type for a function.</a>
- </dt>
- <dt>
- 4.6.3. <a href="coding.html#S28">Minimize function calls
- when iterating by using variables</a>
- </dt>
- <dt>
- 4.6.4. <a href="coding.html#S29">Pass and Return by Const
- Reference</a>
- </dt>
- <dt>
- 4.6.5. <a href="coding.html#S30">Pass and Return by
- Value</a>
- </dt>
- <dt>
- 4.6.6. <a href="coding.html#S31">Names of include
- files</a>
- </dt>
- <dt>
- 4.6.7. <a href="coding.html#S32">Provide multiple
- inclusion protection</a>
- </dt>
- <dt>
- 4.6.8. <a href="coding.html#S33">Use `extern "C"` when
- appropriate</a>
- </dt>
- <dt>
- 4.6.9. <a href="coding.html#S34">Where Possible, Use
- Forward Struct Declaration Instead of Includes</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 4.7. <a href="coding.html#S35">General Coding Practices</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 4.7.1. <a href="coding.html#S36">Turn on warnings</a>
- </dt>
- <dt>
- 4.7.2. <a href="coding.html#S37">Provide a default case
- for all switch statements</a>
- </dt>
- <dt>
- 4.7.3. <a href="coding.html#S38">Try to avoid falling
- through cases in a switch statement.</a>
- </dt>
- <dt>
- 4.7.4. <a href="coding.html#S40">Don't mix size_t and
- other types</a>
- </dt>
- <dt>
- 4.7.5. <a href="coding.html#S41">Declare each variable
- and struct on its own line.</a>
- </dt>
- <dt>
- 4.7.6. <a href="coding.html#S42">Use malloc/zalloc
- sparingly</a>
- </dt>
- <dt>
- 4.7.7. <a href="coding.html#S43">The Programmer Who Uses
- 'malloc' is Responsible for Ensuring 'free'</a>
- </dt>
- <dt>
- 4.7.8. <a href="coding.html#S44">Add loaders to the
- `file_list' structure and in order</a>
- </dt>
- <dt>
- 4.7.9. <a href="coding.html#S45">"Uncertain" new code
- and/or changes to existing code, use XXX</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 4.8. <a href="coding.html#S46">Addendum: Template for files
- and function comment blocks:</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 5. <a href="testing.html">Testing Guidelines</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 5.1. <a href="testing.html#TESTING-PLAN">Testplan for
- releases</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 6. <a href="newrelease.html">Releasing a New Version</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 6.1. <a href="newrelease.html#VERSIONNUMBERS">Version
- numbers</a>
- </dt>
- <dt>
- 6.2. <a href="newrelease.html#BEFORERELEASE">Before the
- Release: Freeze</a>
- </dt>
- <dt>
- 6.3. <a href="newrelease.html#THERELEASE">Building and
- Releasing the Packages</a>
- </dt>
- <dd>
- <dl>
- <dt>
- 6.3.1. <a href="newrelease.html#PACK-GUIDELINES">Note on
- Privoxy Packaging</a>
- </dt>
- <dt>
- 6.3.2. <a href=
- "newrelease.html#NEWRELEASE-TARBALL">Source Tarball</a>
- </dt>
- <dt>
- 6.3.3. <a href="newrelease.html#NEWRELEASE-RPM">SuSE,
- Conectiva or Red Hat RPM</a>
- </dt>
- <dt>
- 6.3.4. <a href="newrelease.html#NEWRELEASE-OS2">OS/2</a>
- </dt>
- <dt>
- 6.3.5. <a href=
- "newrelease.html#NEWRELEASE-SOLARIS">Solaris</a>
- </dt>
- <dt>
- 6.3.6. <a href=
- "newrelease.html#NEWRELEASE-WINDOWS">Windows</a>
- </dt>
- <dt>
- 6.3.7. <a href=
- "newrelease.html#NEWRELEASE-DEBIAN">Debian</a>
- </dt>
- <dt>
- 6.3.8. <a href="newrelease.html#NEWRELEASE-MACOSX">Mac OS
- X</a>
- </dt>
- <dt>
- 6.3.9. <a href=
- "newrelease.html#NEWRELEASE-FREEBSD">FreeBSD</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 6.4. <a href="newrelease.html#RELEASING">Uploading and
- Releasing Your Package</a>
- </dt>
- <dt>
- 6.5. <a href="newrelease.html#AFTERRELEASE">After the
- Release</a>
- </dt>
- </dl>
- </dd>
- <dt>
- 7. <a href="webserver-update.html">Update the Webserver</a>
- </dt>
- </dl>
</div>
</div>
! <div class="NAVFOOTER">
! <hr align="LEFT" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top">
!
! </td>
! <td width="34%" align="center" valign="top">
!
! </td>
! <td width="33%" align="right" valign="top">
! <a href="introduction.html" accesskey="N">Next</a>
! </td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">
!
! </td>
! <td width="34%" align="center" valign="top">
!
! </td>
! <td width="33%" align="right" valign="top">
! Introduction
! </td>
! </tr>
! </table>
</div>
! </body>
</html>
-
--- 1,253 ----
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
! "http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>Privoxy Developer Manual</title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="NEXT" title="Introduction" href="introduction.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
! </head>
! <body class="ARTICLE" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="ARTICLE">
! <div class="TITLEPAGE">
! <h1 class="TITLE"><a name="AEN2" id="AEN2">Privoxy Developer
! Manual</a></h1>
! <p class="PUBDATE"><sub><a href=
! "https://www.privoxy.org/user-manual/copyright.html" target=
! "_top">Copyright</a> � 2001-2016 by <a href="https://www.privoxy.org/"
! target="_top">Privoxy Developers</a></sub><br></p>
! <p class="PUBDATE">$Id: developer-manual.sgml,v 2.81 2016/08/26
! 12:32:19 fabiankeil Exp $<br></p>
! <div>
! <div class="ABSTRACT">
! <a name="AEN9" id="AEN9"></a>
! <p>The developer manual provides guidance on coding, testing,
! packaging, documentation and other issues of importance to those
! involved with <span class="APPLICATION">Privoxy</span> development.
! It is mandatory (and helpful!) reading for anyone who wants to join
! the team. Note that it's currently out of date and may not be
! entirely correct. As always, patches are welcome.</p>
! <p>Please note that this document is constantly evolving. This copy
! represents the state at the release of version 3.0.26. You can find
! the latest version of the this manual at <a href=
! "https://www.privoxy.org/developer-manual/" target=
! "_top">https://www.privoxy.org/developer-manual/</a>. Please have a
! look at the <a href=
! "https://www.privoxy.org/user-manual/contact.html" target=
! "_top">contact section in the user manual</a> if you are interested
! in contacting the developers.</p>
</div>
</div>
+ <hr>
</div>
! <div class="TOC">
! <dl>
! <dt><b>Table of Contents</b></dt>
! <dt>1. <a href="introduction.html">Introduction</a></dt>
! <dd>
! <dl>
! <dt>1.1. <a href="introduction.html#QUICKSTART">Quickstart to
! Privoxy Development</a></dt>
! </dl>
! </dd>
! <dt>2. <a href="cvs.html">The CVS Repository</a></dt>
! <dd>
! <dl>
! <dt>2.1. <a href="cvs.html#CVSACCESS">Access to CVS</a></dt>
! <dt>2.2. <a href="cvs.html#CVSBRANCHES">Branches</a></dt>
! <dt>2.3. <a href="cvs.html#CVSCOMMIT">CVS Commit
! Guidelines</a></dt>
! </dl>
! </dd>
! <dt>3. <a href="documentation.html">Documentation Guidelines</a></dt>
! <dd>
! <dl>
! <dt>3.1. <a href="documentation.html#SGML">Quickstart to Docbook
! and SGML</a></dt>
! <dt>3.2. <a href="documentation.html#DOCSTYLE"><span class=
! "APPLICATION">Privoxy</span> Documentation Style</a></dt>
! <dt>3.3. <a href="documentation.html#AEN207">Privoxy Custom
! Entities</a></dt>
! </dl>
! </dd>
! <dt>4. <a href="coding.html">Coding Guidelines</a></dt>
! <dd>
! <dl>
! <dt>4.1. <a href="coding.html#S1">Introduction</a></dt>
! <dt>4.2. <a href="coding.html#S2">Using Comments</a></dt>
! <dd>
! <dl>
! <dt>4.2.1. <a href="coding.html#S3">Comment, Comment,
! Comment</a></dt>
! <dt>4.2.2. <a href="coding.html#S4">Use blocks for
! comments</a></dt>
! <dt>4.2.3. <a href="coding.html#S5">Keep Comments on their
! own line</a></dt>
! <dt>4.2.4. <a href="coding.html#S6">Comment each logical
! step</a></dt>
! <dt>4.2.5. <a href="coding.html#S7">Comment All Functions
! Thoroughly</a></dt>
! <dt>4.2.6. <a href="coding.html#S8">Comment at the end of
! braces if the content is more than one screen length</a></dt>
! </dl>
! </dd>
! <dt>4.3. <a href="coding.html#S9">Naming Conventions</a></dt>
! <dd>
! <dl>
! <dt>4.3.1. <a href="coding.html#S10">Variable Names</a></dt>
! <dt>4.3.2. <a href="coding.html#S11">Function Names</a></dt>
! <dt>4.3.3. <a href="coding.html#S12">Header file
! prototypes</a></dt>
! <dt>4.3.4. <a href="coding.html#S13">Enumerations, and
! #defines</a></dt>
! <dt>4.3.5. <a href="coding.html#S14">Constants</a></dt>
! </dl>
! </dd>
! <dt>4.4. <a href="coding.html#S15">Using Space</a></dt>
! <dd>
! <dl>
! <dt>4.4.1. <a href="coding.html#S16">Put braces on a line by
! themselves.</a></dt>
! <dt>4.4.2. <a href="coding.html#S17">ALL control statements
! should have a block</a></dt>
! <dt>4.4.3. <a href="coding.html#S18">Do not belabor/blow-up
! boolean expressions</a></dt>
! <dt>4.4.4. <a href="coding.html#S19">Use white space freely
! because it is free</a></dt>
! <dt>4.4.5. <a href="coding.html#S20">Don't use white space
! around structure operators</a></dt>
! <dt>4.4.6. <a href="coding.html#S21">Make the last brace of a
! function stand out</a></dt>
! <dt>4.4.7. <a href="coding.html#S22">Use 3 character
! indentions</a></dt>
! </dl>
! </dd>
! <dt>4.5. <a href="coding.html#S23">Initializing</a></dt>
! <dd>
! <dl>
! <dt>4.5.1. <a href="coding.html#S24">Initialize all
! variables</a></dt>
! </dl>
! </dd>
! <dt>4.6. <a href="coding.html#S25">Functions</a></dt>
! <dd>
! <dl>
! <dt>4.6.1. <a href="coding.html#S26">Name functions that
! return a boolean as a question.</a></dt>
! <dt>4.6.2. <a href="coding.html#S27">Always specify a return
! type for a function.</a></dt>
! <dt>4.6.3. <a href="coding.html#S28">Minimize function calls
! when iterating by using variables</a></dt>
! <dt>4.6.4. <a href="coding.html#S29">Pass and Return by Const
! Reference</a></dt>
! <dt>4.6.5. <a href="coding.html#S30">Pass and Return by
! Value</a></dt>
! <dt>4.6.6. <a href="coding.html#S31">Names of include
! files</a></dt>
! <dt>4.6.7. <a href="coding.html#S32">Provide multiple
! inclusion protection</a></dt>
! <dt>4.6.8. <a href="coding.html#S33">Use `extern "C"` when
! appropriate</a></dt>
! <dt>4.6.9. <a href="coding.html#S34">Where Possible, Use
! Forward Struct Declaration Instead of Includes</a></dt>
! </dl>
! </dd>
! <dt>4.7. <a href="coding.html#S35">General Coding
! Practices</a></dt>
! <dd>
! <dl>
! <dt>4.7.1. <a href="coding.html#S36">Turn on
! warnings</a></dt>
! <dt>4.7.2. <a href="coding.html#S37">Provide a default case
! for all switch statements</a></dt>
! <dt>4.7.3. <a href="coding.html#S38">Try to avoid falling
! through cases in a switch statement.</a></dt>
! <dt>4.7.4. <a href="coding.html#S40">Don't mix size_t and
! other types</a></dt>
! <dt>4.7.5. <a href="coding.html#S41">Declare each variable
! and struct on its own line.</a></dt>
! <dt>4.7.6. <a href="coding.html#S42">Use malloc/zalloc
! sparingly</a></dt>
! <dt>4.7.7. <a href="coding.html#S43">The Programmer Who Uses
! 'malloc' is Responsible for Ensuring 'free'</a></dt>
! <dt>4.7.8. <a href="coding.html#S44">Add loaders to the
! `file_list' structure and in order</a></dt>
! <dt>4.7.9. <a href="coding.html#S45">"Uncertain" new code
! and/or changes to existing code, use XXX</a></dt>
! </dl>
! </dd>
! <dt>4.8. <a href="coding.html#S46">Addendum: Template for files
! and function comment blocks:</a></dt>
! </dl>
! </dd>
! <dt>5. <a href="testing.html">Testing Guidelines</a></dt>
! <dd>
! <dl>
! <dt>5.1. <a href="testing.html#TESTING-PLAN">Testplan for
! releases</a></dt>
! <dt>5.2. <a href="testing.html#FUZZING">Fuzzing Privoxy</a></dt>
! </dl>
! </dd>
! <dt>6. <a href="newrelease.html">Releasing a New Version</a></dt>
! <dd>
! <dl>
! <dt>6.1. <a href="newrelease.html#VERSIONNUMBERS">Version
! numbers</a></dt>
! <dt>6.2. <a href="newrelease.html#BEFORERELEASE">Before the
! Release: Freeze</a></dt>
! <dt>6.3. <a href="newrelease.html#THERELEASE">Building and
! Releasing the Packages</a></dt>
! <dd>
! <dl>
! <dt>6.3.1. <a href="newrelease.html#PACK-GUIDELINES">Note on
! Privoxy Packaging</a></dt>
! <dt>6.3.2. <a href=
! "newrelease.html#NEWRELEASE-TARBALL">Source Tarball</a></dt>
! <dt>6.3.3. <a href="newrelease.html#NEWRELEASE-RPM">SuSE,
! Conectiva or Red Hat RPM</a></dt>
! <dt>6.3.4. <a href=
! "newrelease.html#NEWRELEASE-OS2">OS/2</a></dt>
! <dt>6.3.5. <a href=
! "newrelease.html#NEWRELEASE-SOLARIS">Solaris</a></dt>
! <dt>6.3.6. <a href=
! "newrelease.html#NEWRELEASE-WINDOWS">Windows</a></dt>
! <dt>6.3.7. <a href=
! "newrelease.html#NEWRELEASE-DEBIAN">Debian</a></dt>
! <dt>6.3.8. <a href="newrelease.html#NEWRELEASE-MACOSX">Mac OS
! X</a></dt>
! <dt>6.3.9. <a href=
! "newrelease.html#NEWRELEASE-FREEBSD">FreeBSD</a></dt>
! </dl>
! </dd>
! <dt>6.4. <a href="newrelease.html#RELEASING">Uploading and
! Releasing Your Package</a></dt>
! <dt>6.5. <a href="newrelease.html#AFTERRELEASE">After the
! Release</a></dt>
! </dl>
! </dd>
! <dt>7. <a href="webserver-update.html">Update the Webserver</a></dt>
! </dl>
</div>
! </div>
! <div class="NAVFOOTER">
! <hr align="left" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top"> </td>
! <td width="34%" align="center" valign="top"> </td>
! <td width="33%" align="right" valign="top"><a href=
! "introduction.html" accesskey="N">Next</a></td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top"> </td>
! <td width="34%" align="center" valign="top"> </td>
! <td width="33%" align="right" valign="top">Introduction</td>
! </tr>
! </table>
! </div>
! </body>
</html>
Index: webserver-update.html
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/webserver-update.html,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -d -r1.17 -r1.18
*** webserver-update.html 26 Aug 2016 12:32:48 -0000 1.17
--- webserver-update.html 12 Jan 2017 14:27:46 -0000 1.18
***************
*** 1,144 ****
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
! Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>
! Update the Webserver
! </title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="Releasing a New Version" href=
! "newrelease.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">
! Privoxy Developer Manual
! </th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom">
! <a href="newrelease.html" accesskey="P">Prev</a>
! </td>
! <td width="80%" align="center" valign="bottom">
! </td>
! <td width="10%" align="right" valign="bottom">
!
! </td>
! </tr>
! </table>
! <hr align="LEFT" width="100%">
! </div>
! <div class="SECT1">
! <h1 class="SECT1">
! <a name="WEBSERVER-UPDATE">7. Update the Webserver</a>
! </h1>
! <p>
! The webserver should be updated at least with each stable release.
! When updating, please follow these steps to make sure that no broken
! links, inconsistent contents or permission problems will occur (as it
! has many times in the past!):
! </p>
! <p>
! If you have changed anything in the stable-branch documentation
! source SGML files, do:
! </p>
! <p>
! </p>
! <table border="0" bgcolor="#E0E0E0" width="100%">
! <tr>
! <td>
! <pre class="PROGRAMLISTING">
! make dok
! </pre>
! </td>
! </tr>
! </table>
!
! <p>
! That will generate <tt class=
! "FILENAME">doc/webserver/user-manual</tt>, <tt class=
! "FILENAME">doc/webserver/developer-manual</tt>, <tt class=
! "FILENAME">doc/webserver/faq</tt>, <tt class=
! "FILENAME">doc/webserver/index.html</tt> automatically.
! </p>
! <p>
! If you changed the manual page sources, generate <tt class=
! "FILENAME">doc/webserver/man-page/privoxy-man-page.html</tt> by
! running <span class="QUOTE">"<b class="COMMAND">make man</b>"</span>.
! (This is a separate target due to dependencies on some obscure perl
! scripts [now in CVS, but not well tested]. See comments in <tt class=
! "FILENAME">GNUmakefile</tt>.)
! </p>
! <p>
! If you want to add new files to the webserver, create them locally in
! the <tt class="FILENAME">doc/webserver/*</tt> directory (or create
! new directories under <tt class="FILENAME">doc/webserver</tt>).
! </p>
! <p>
! Next, commit any changes from the above steps to CVS. All set? If
! these are docs in the stable branch, then do:
! </p>
! <p>
! </p>
! <table border="0" bgcolor="#E0E0E0" width="100%">
! <tr>
! <td>
! <pre class="PROGRAMLISTING">
! make webserver
! </pre>
! </td>
! </tr>
! </table>
!
! <p>
! This will do the upload to <a href="https://www.privoxy.org/" target=
! "_top">the webserver</a> (www.privoxy.org) and ensure all files and
! directories there are group writable.
! </p>
! <p>
! Please do <span class="emphasis"><i class="EMPHASIS">NOT</i></span>
! use any other means of transferring files to the webserver to avoid
! permission problems. Also, please do not upload docs from development
! branches or versions. The publicly posted docs should be in sync with
! the last official release.
! </p>
! </div>
! <div class="NAVFOOTER">
! <hr align="LEFT" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top">
! <a href="newrelease.html" accesskey="P">Prev</a>
! </td>
! <td width="34%" align="center" valign="top">
! <a href="index.html" accesskey="H">Home</a>
! </td>
! <td width="33%" align="right" valign="top">
!
! </td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">
! Releasing a New Version
! </td>
! <td width="34%" align="center" valign="top">
!
! </td>
! <td width="33%" align="right" valign="top">
!
! </td>
! </tr>
! </table>
! </div>
! </body>
</html>
-
--- 1,99 ----
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
! "http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>Update the Webserver</title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="Releasing a New Version" href=
! "newrelease.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">Privoxy Developer Manual</th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom"><a href=
! "newrelease.html" accesskey="P">Prev</a></td>
! <td width="80%" align="center" valign="bottom"></td>
! <td width="10%" align="right" valign="bottom"> </td>
! </tr>
! </table>
! <hr align="left" width="100%">
! </div>
! <div class="SECT1">
! <h1 class="SECT1"><a name="WEBSERVER-UPDATE" id="WEBSERVER-UPDATE">7.
! Update the Webserver</a></h1>
! <p>The webserver should be updated at least with each stable release.
! When updating, please follow these steps to make sure that no broken
! links, inconsistent contents or permission problems will occur (as it has
! many times in the past!):</p>
! <p>If you have changed anything in the stable-branch documentation source
! SGML files, do:</p>
! <table border="0" bgcolor="#E0E0E0" width="100%">
! <tr>
! <td>
! <pre class="PROGRAMLISTING"> make dok</pre>
! </td>
! </tr>
! </table>
! <p>That will generate <tt class=
! "FILENAME">doc/webserver/user-manual</tt>, <tt class=
! "FILENAME">doc/webserver/developer-manual</tt>, <tt class=
! "FILENAME">doc/webserver/faq</tt>, <tt class=
! "FILENAME">doc/webserver/index.html</tt> automatically.</p>
! <p>If you changed the manual page sources, generate <tt class=
! "FILENAME">doc/webserver/man-page/privoxy-man-page.html</tt> by running
! <span class="QUOTE">"<b class="COMMAND">make man</b>"</span>. (This is a
! separate target due to dependencies on some obscure perl scripts [now in
! CVS, but not well tested]. See comments in <tt class=
! "FILENAME">GNUmakefile</tt>.)</p>
! <p>If you want to add new files to the webserver, create them locally in
! the <tt class="FILENAME">doc/webserver/*</tt> directory (or create new
! directories under <tt class="FILENAME">doc/webserver</tt>).</p>
! <p>Next, commit any changes from the above steps to CVS. All set? If
! these are docs in the stable branch, then do:</p>
! <table border="0" bgcolor="#E0E0E0" width="100%">
! <tr>
! <td>
! <pre class="PROGRAMLISTING"> make webserver</pre>
! </td>
! </tr>
! </table>
! <p>This will do the upload to <a href="https://www.privoxy.org/" target=
! "_top">the webserver</a> (www.privoxy.org) and ensure all files and
! directories there are group writable.</p>
! <p>Please do <span class="emphasis"><i class="EMPHASIS">NOT</i></span>
! use any other means of transferring files to the webserver to avoid
! permission problems. Also, please do not upload docs from development
! branches or versions. The publicly posted docs should be in sync with the
! last official release.</p>
! </div>
! <div class="NAVFOOTER">
! <hr align="left" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top"><a href="newrelease.html"
! accesskey="P">Prev</a></td>
! <td width="34%" align="center" valign="top"><a href="index.html"
! accesskey="H">Home</a></td>
! <td width="33%" align="right" valign="top"> </td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">Releasing a New
! Version</td>
! <td width="34%" align="center" valign="top"> </td>
! <td width="33%" align="right" valign="top"> </td>
! </tr>
! </table>
! </div>
! </body>
</html>
Index: cvs.html
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/cvs.html,v
retrieving revision 1.26
retrieving revision 1.27
diff -C2 -d -r1.26 -r1.27
*** cvs.html 26 Aug 2016 12:32:48 -0000 1.26
--- cvs.html 12 Jan 2017 14:27:46 -0000 1.27
***************
*** 1,179 ****
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
! Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>
! The CVS Repository
! </title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="Introduction" href="introduction.html">
! <link rel="NEXT" title="Documentation Guidelines" href=
! "documentation.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">
! Privoxy Developer Manual
! </th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom">
! <a href="introduction.html" accesskey="P">Prev</a>
! </td>
! <td width="80%" align="center" valign="bottom">
! </td>
! <td width="10%" align="right" valign="bottom">
! <a href="documentation.html" accesskey="N">Next</a>
! </td>
! </tr>
! </table>
! <hr align="LEFT" width="100%">
</div>
! <div class="SECT1">
! <h1 class="SECT1">
! <a name="CVS">2. The CVS Repository</a>
! </h1>
! <p>
! 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 team members will need to set this up for you. Please read
! this chapter completely before accessing via CVS.
! </p>
! <div class="SECT2">
! <h2 class="SECT2">
! <a name="CVSACCESS">2.1. Access to CVS</a>
! </h2>
! <p>
! The project's CVS repository is hosted on <a href=
! "https://sourceforge.net/" target="_top">SourceForge.</a> For
! historical reasons, the CVS server is called <tt class=
! "LITERAL">ijbswa.cvs.sourceforge.net</tt>, the repository is called
! <tt class="LITERAL">ijbswa</tt>, and the source tree module is
! called <tt class="LITERAL">current</tt>.
! </p>
! </div>
! <div class="SECT2">
! <h2 class="SECT2">
! <a name="CVSBRANCHES">2.2. Branches</a>
! </h2>
! <p>
! Within the CVS repository, there are modules and branches. As
! mentioned, the sources are in the <tt class="LITERAL">current</tt>
! <span class="QUOTE">"module"</span>. Other modules are present for
! platform specific issues. There is a webview of the CVS hierarchy
! at <a href="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/"
! target="_top">http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</a>,
! which might help with visualizing how these pieces fit together.
! </p>
! <p>
! At one time there were two distinct branches: stable and unstable.
! The more drastic changes were to be in the unstable branch. These
! branches have now been merged to minimize time and effort of
! maintaining two branches.
! </p>
! </div>
! <div class="SECT2">
! <h2 class="SECT2">
! <a name="CVSCOMMIT">2.3. CVS Commit Guidelines</a>
! </h2>
! <p>
! 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 adhere to the following guidelines:
! </p>
! <p>
! Basic Guidelines, for all branches:
! </p>
! <p>
! </p>
! <ul>
! <li>
! <p>
! Please don't commit even a small change without testing it
! thoroughly first. When we're close to a public release, ask a
! fellow developer to review your changes.
! </p>
! </li>
! <li>
! <p>
! Your commit message should give a concise overview of <span
! class="emphasis"><i class="EMPHASIS">what you
! changed</i></span> (no big details) and <span class=
! "emphasis"><i class="EMPHASIS">why you changed it</i></span>
! Just check previous messages for good examples.
! </p>
! </li>
! <li>
! <p>
! Don't use the same message on multiple files, unless it equally
! applies to all those files.
! </p>
! </li>
! <li>
! <p>
! If your changes span multiple files, and the code won't
! recompile unless all changes are committed (e.g. when changing
! the signature of a function), then commit all files one after
! another, without long delays in between. If necessary, prepare
! the commit messages in advance.
! </p>
! </li>
! <li>
! <p>
! Before changing things on CVS, make sure that your changes are
! in line with the team's general consensus on what should be
! done.
! </p>
! </li>
! <li>
! <p>
! Note that near a major public release, we get more cautious.
! There is always the possibility to submit a patch to the <a
! href=
! "https://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse"
! target="_top">patch tracker</a> instead.
! </p>
! </li>
! </ul>
! </div>
</div>
! <div class="NAVFOOTER">
! <hr align="LEFT" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top">
! <a href="introduction.html" accesskey="P">Prev</a>
! </td>
! <td width="34%" align="center" valign="top">
! <a href="index.html" accesskey="H">Home</a>
! </td>
! <td width="33%" align="right" valign="top">
! <a href="documentation.html" accesskey="N">Next</a>
! </td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">
! Introduction
! </td>
! <td width="34%" align="center" valign="top">
!
! </td>
! <td width="33%" align="right" valign="top">
! Documentation Guidelines
! </td>
! </tr>
! </table>
</div>
! </body>
</html>
-
--- 1,131 ----
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
! "http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>The CVS Repository</title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="Introduction" href="introduction.html">
! <link rel="NEXT" title="Documentation Guidelines" href=
! "documentation.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">Privoxy Developer Manual</th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom"><a href=
! "introduction.html" accesskey="P">Prev</a></td>
! <td width="80%" align="center" valign="bottom"></td>
! <td width="10%" align="right" valign="bottom"><a href=
! "documentation.html" accesskey="N">Next</a></td>
! </tr>
! </table>
! <hr align="left" width="100%">
! </div>
! <div class="SECT1">
! <h1 class="SECT1"><a name="CVS" id="CVS">2. The CVS Repository</a></h1>
! <p>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 team
! members will need to set this up for you. Please read this chapter
! completely before accessing via CVS.</p>
! <div class="SECT2">
! <h2 class="SECT2"><a name="CVSACCESS" id="CVSACCESS">2.1. Access to
! CVS</a></h2>
! <p>The project's CVS repository is hosted on <a href=
! "https://sourceforge.net/" target="_top">SourceForge.</a> For
! historical reasons, the CVS server is called <tt class=
! "LITERAL">ijbswa.cvs.sourceforge.net</tt>, the repository is called
! <tt class="LITERAL">ijbswa</tt>, and the source tree module is called
! <tt class="LITERAL">current</tt>.</p>
</div>
! <div class="SECT2">
! <h2 class="SECT2"><a name="CVSBRANCHES" id="CVSBRANCHES">2.2.
! Branches</a></h2>
! <p>Within the CVS repository, there are modules and branches. As
! mentioned, the sources are in the <tt class="LITERAL">current</tt>
! <span class="QUOTE">"module"</span>. Other modules are present for
! platform specific issues. There is a webview of the CVS hierarchy at
! <a href="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/" target=
! "_top">http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/</a>, which
! might help with visualizing how these pieces fit together.</p>
! <p>At one time there were two distinct branches: stable and unstable.
! The more drastic changes were to be in the unstable branch. These
! branches have now been merged to minimize time and effort of
! maintaining two branches.</p>
</div>
! <div class="SECT2">
! <h2 class="SECT2"><a name="CVSCOMMIT" id="CVSCOMMIT">2.3. CVS Commit
! Guidelines</a></h2>
! <p>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 adhere to
! the following guidelines:</p>
! <p>Basic Guidelines, for all branches:</p>
! <ul>
! <li>
! <p>Please don't commit even a small change without testing it
! thoroughly first. When we're close to a public release, ask a
! fellow developer to review your changes.</p>
! </li>
! <li>
! <p>Your commit message should give a concise overview of
! <span class="emphasis"><i class="EMPHASIS">what you
! changed</i></span> (no big details) and <span class=
! "emphasis"><i class="EMPHASIS">why you changed it</i></span> Just
! check previous messages for good examples.</p>
! </li>
! <li>
! <p>Don't use the same message on multiple files, unless it equally
! applies to all those files.</p>
! </li>
! <li>
! <p>If your changes span multiple files, and the code won't
! recompile unless all changes are committed (e.g. when changing the
! signature of a function), then commit all files one after another,
! without long delays in between. If necessary, prepare the commit
! messages in advance.</p>
! </li>
! <li>
! <p>Before changing things on CVS, make sure that your changes are
! in line with the team's general consensus on what should be
! done.</p>
! </li>
! <li>
! <p>Note that near a major public release, we get more cautious.
! There is always the possibility to submit a patch to the <a href=
! "https://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse"
! target="_top">patch tracker</a> instead.</p>
! </li>
! </ul>
</div>
! </div>
! <div class="NAVFOOTER">
! <hr align="left" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top"><a href="introduction.html"
! accesskey="P">Prev</a></td>
! <td width="34%" align="center" valign="top"><a href="index.html"
! accesskey="H">Home</a></td>
! <td width="33%" align="right" valign="top"><a href=
! "documentation.html" accesskey="N">Next</a></td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">Introduction</td>
! <td width="34%" align="center" valign="top"> </td>
! <td width="33%" align="right" valign="top">Documentation
! Guidelines</td>
! </tr>
! </table>
! </div>
! </body>
</html>
Index: coding.html
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/coding.html,v
retrieving revision 1.65
retrieving revision 1.66
diff -C2 -d -r1.65 -r1.66
*** coding.html 26 Aug 2016 12:32:48 -0000 1.65
--- coding.html 12 Jan 2017 14:27:46 -0000 1.66
***************
*** 1,98 ****
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
! Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>
! Coding Guidelines
! </title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
[...2644 lines suppressed...]
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top"><a href=
! "documentation.html" accesskey="P">Prev</a></td>
! <td width="34%" align="center" valign="top"><a href="index.html"
! accesskey="H">Home</a></td>
! <td width="33%" align="right" valign="top"><a href="testing.html"
! accesskey="N">Next</a></td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">Documentation
! Guidelines</td>
! <td width="34%" align="center" valign="top"> </td>
! <td width="33%" align="right" valign="top">Testing Guidelines</td>
! </tr>
! </table>
! </div>
! </body>
</html>
Index: testing.html
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/testing.html,v
retrieving revision 1.24
retrieving revision 1.25
diff -C2 -d -r1.24 -r1.25
*** testing.html 26 Aug 2016 12:32:48 -0000 1.24
--- testing.html 12 Jan 2017 14:27:46 -0000 1.25
***************
*** 1,148 ****
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
! Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>
! Testing Guidelines
! </title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="Coding Guidelines" href="coding.html">
! <link rel="NEXT" title="Releasing a New Version" href="newrelease.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">
! Privoxy Developer Manual
! </th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom">
! <a href="coding.html" accesskey="P">Prev</a>
! </td>
! <td width="80%" align="center" valign="bottom">
! </td>
! <td width="10%" align="right" valign="bottom">
! <a href="newrelease.html" accesskey="N">Next</a>
! </td>
! </tr>
! </table>
! <hr align="LEFT" width="100%">
! </div>
! <div class="SECT1">
! <h1 class="SECT1">
! <a name="TESTING">5. Testing Guidelines</a>
! </h1>
! <p>
! To be filled.
! </p>
! <div class="SECT2">
! <h2 class="SECT2">
! <a name="TESTING-PLAN">5.1. Testplan for releases</a>
! </h2>
! <p>
! Explain release numbers. major, minor. developer releases. etc.
! </p>
! <ol type="1">
! <li>
! <p>
! Remove any existing rpm with rpm -e
! </p>
! </li>
! <li>
! <p>
! Remove any file that was left over. This includes (but is not
! limited to)
! </p>
! <ul>
! <li>
! <p>
! /var/log/privoxy
! </p>
! </li>
! <li>
! <p>
! /etc/privoxy
! </p>
! </li>
! <li>
! <p>
! /usr/sbin/privoxy
! </p>
! </li>
! <li>
! <p>
! /etc/init.d/privoxy
! </p>
! </li>
! <li>
! <p>
! /usr/doc/privoxy*
! </p>
! </li>
! </ul>
! </li>
! <li>
! <p>
! Install the rpm. Any error messages?
! </p>
! </li>
! <li>
! <p>
! start,stop,status <span class="APPLICATION">Privoxy</span> with
! the specific script (e.g. /etc/rc.d/init/privoxy stop). Reboot
! your machine. Does autostart work?
! </p>
! </li>
! <li>
! <p>
! Start browsing. Does <span class="APPLICATION">Privoxy</span>
! work? Logfile written?
! </p>
! </li>
! <li>
! <p>
! Remove the rpm. Any error messages? All files removed?
! </p>
! </li>
! </ol>
! </div>
</div>
! <div class="NAVFOOTER">
! <hr align="LEFT" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top">
! <a href="coding.html" accesskey="P">Prev</a>
! </td>
! <td width="34%" align="center" valign="top">
! <a href="index.html" accesskey="H">Home</a>
! </td>
! <td width="33%" align="right" valign="top">
! <a href="newrelease.html" accesskey="N">Next</a>
! </td>
! </tr>
<tr>
! <td width="33%" align="left" valign="top">
! Coding Guidelines
! </td>
! <td width="34%" align="center" valign="top">
!
! </td>
! <td width="33%" align="right" valign="top">
! Releasing a New Version
</td>
</tr>
</table>
</div>
! </body>
</html>
-
--- 1,169 ----
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
! "http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>Testing Guidelines</title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="Coding Guidelines" href="coding.html">
! <link rel="NEXT" title="Releasing a New Version" href="newrelease.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">Privoxy Developer Manual</th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom"><a href="coding.html"
! accesskey="P">Prev</a></td>
! <td width="80%" align="center" valign="bottom"></td>
! <td width="10%" align="right" valign="bottom"><a href=
! "newrelease.html" accesskey="N">Next</a></td>
! </tr>
! </table>
! <hr align="left" width="100%">
! </div>
! <div class="SECT1">
! <h1 class="SECT1"><a name="TESTING" id="TESTING">5. Testing
! Guidelines</a></h1>
! <p>To be filled.</p>
! <div class="SECT2">
! <h2 class="SECT2"><a name="TESTING-PLAN" id="TESTING-PLAN">5.1.
! Testplan for releases</a></h2>
! <p>Explain release numbers. major, minor. developer releases. etc.</p>
! <ol type="1">
! <li>
! <p>Remove any existing rpm with rpm -e</p>
! </li>
! <li>
! <p>Remove any file that was left over. This includes (but is not
! limited to)</p>
! <ul>
! <li>
! <p>/var/log/privoxy</p>
! </li>
! <li>
! <p>/etc/privoxy</p>
! </li>
! <li>
! <p>/usr/sbin/privoxy</p>
! </li>
! <li>
! <p>/etc/init.d/privoxy</p>
! </li>
! <li>
! <p>/usr/doc/privoxy*</p>
! </li>
! </ul>
! </li>
! <li>
! <p>Install the rpm. Any error messages?</p>
! </li>
! <li>
! <p>start,stop,status <span class="APPLICATION">Privoxy</span> with
! the specific script (e.g. /etc/rc.d/init/privoxy stop). Reboot your
! machine. Does autostart work?</p>
! </li>
! <li>
! <p>Start browsing. Does <span class="APPLICATION">Privoxy</span>
! work? Logfile written?</p>
! </li>
! <li>
! <p>Remove the rpm. Any error messages? All files removed?</p>
! </li>
! </ol>
</div>
! <div class="SECT2">
! <h2 class="SECT2"><a name="FUZZING" id="FUZZING">5.2. Fuzzing
! Privoxy</a></h2>
! <p>To make fuzzing more convenient, Privoxy can be configured with
! --enable-fuzz which will result in the --fuzz option becoming
! available.</p>
! <p>Example (tested on ElectroBSD):</p>
! <table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
! <td>
! <pre class="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</pre>
</td>
</tr>
</table>
</div>
! </div>
! <div class="NAVFOOTER">
! <hr align="left" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top"><a href="coding.html"
! accesskey="P">Prev</a></td>
! <td width="34%" align="center" valign="top"><a href="index.html"
! accesskey="H">Home</a></td>
! <td width="33%" align="right" valign="top"><a href="newrelease.html"
! accesskey="N">Next</a></td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">Coding Guidelines</td>
! <td width="34%" align="center" valign="top"> </td>
! <td width="33%" align="right" valign="top">Releasing a New
! Version</td>
! </tr>
! </table>
! </div>
! </body>
</html>
Index: newrelease.html
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/newrelease.html,v
retrieving revision 1.62
retrieving revision 1.63
diff -C2 -d -r1.62 -r1.63
*** newrelease.html 26 Aug 2016 12:32:48 -0000 1.62
--- newrelease.html 12 Jan 2017 14:27:46 -0000 1.63
***************
*** 1,1194 ****
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
! Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>
! Releasing a New Version
! </title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
[...2005 lines suppressed...]
! <hr align="left" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top"><a href="testing.html"
! accesskey="P">Prev</a></td>
! <td width="34%" align="center" valign="top"><a href="index.html"
! accesskey="H">Home</a></td>
! <td width="33%" align="right" valign="top"><a href=
! "webserver-update.html" accesskey="N">Next</a></td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">Testing Guidelines</td>
! <td width="34%" align="center" valign="top"> </td>
! <td width="33%" align="right" valign="top">Update the Webserver</td>
! </tr>
! </table>
! </div>
! </body>
</html>
Index: introduction.html
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/introduction.html,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -d -r1.17 -r1.18
*** introduction.html 26 Aug 2016 12:32:48 -0000 1.17
--- introduction.html 12 Jan 2017 14:27:46 -0000 1.18
***************
*** 1,113 ****
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
! Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>
! Introduction
! </title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="Privoxy Developer Manual" href="index.html">
! <link rel="NEXT" title="The CVS Repository" href="cvs.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">
! Privoxy Developer Manual
! </th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom">
! <a href="index.html" accesskey="P">Prev</a>
! </td>
! <td width="80%" align="center" valign="bottom">
! </td>
! <td width="10%" align="right" valign="bottom">
! <a href="cvs.html" accesskey="N">Next</a>
! </td>
! </tr>
! </table>
! <hr align="LEFT" width="100%">
! </div>
! <div class="SECT1">
! <h1 class="SECT1">
! <a name="INTRODUCTION">1. Introduction</a>
! </h1>
! <p>
! <span class="APPLICATION">Privoxy</span>, as an heir to <span class=
! "APPLICATION">Junkbuster</span>, is a Free Software project and the
! code is licensed under the GNU General Public License version 2. As
! such, <span class="APPLICATION">Privoxy</span> development is
! potentially open to anyone who has the time, knowledge, and desire to
! contribute in any capacity. Our goals are simply to continue the
! mission, to improve <span class="APPLICATION">Privoxy</span>, and to
! make it available to as wide an audience as possible.
! </p>
! <p>
! One does not have to be a programmer to contribute. Packaging,
! testing, documenting and porting, are all important jobs as well.
! </p>
! <div class="SECT2">
! <h2 class="SECT2">
! <a name="QUICKSTART">1.1. Quickstart to Privoxy Development</a>
! </h2>
! <p>
! The first step is to join the <a href=
! "https://lists.privoxy.org/mailman/listinfo/privoxy-devel" target=
! "_top">privoxy-devel mailing list</a>. 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.
! </p>
! <p>
! 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).
! </p>
! <p>
! For the time being (read, this section is under construction), you
! can also refer to the extensive comments in the source code. In
! fact, reading the code is recommended in any case.
! </p>
! </div>
! </div>
! <div class="NAVFOOTER">
! <hr align="LEFT" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top">
! <a href="index.html" accesskey="P">Prev</a>
! </td>
! <td width="34%" align="center" valign="top">
! <a href="index.html" accesskey="H">Home</a>
! </td>
! <td width="33%" align="right" valign="top">
! <a href="cvs.html" accesskey="N">Next</a>
! </td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">
! Privoxy Developer Manual
! </td>
! <td width="34%" align="center" valign="top">
!
! </td>
! <td width="33%" align="right" valign="top">
! The CVS Repository
! </td>
! </tr>
! </table>
</div>
! </body>
</html>
-
--- 1,85 ----
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
! "http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>Introduction</title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="Privoxy Developer Manual" href="index.html">
! <link rel="NEXT" title="The CVS Repository" href="cvs.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">Privoxy Developer Manual</th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom"><a href="index.html"
! accesskey="P">Prev</a></td>
! <td width="80%" align="center" valign="bottom"></td>
! <td width="10%" align="right" valign="bottom"><a href="cvs.html"
! accesskey="N">Next</a></td>
! </tr>
! </table>
! <hr align="left" width="100%">
! </div>
! <div class="SECT1">
! <h1 class="SECT1"><a name="INTRODUCTION" id="INTRODUCTION">1.
! Introduction</a></h1>
! <p><span class="APPLICATION">Privoxy</span>, as an heir to <span class=
! "APPLICATION">Junkbuster</span>, is a Free Software project and the code
! is licensed under the GNU General Public License version 2. As such,
! <span class="APPLICATION">Privoxy</span> development is potentially open
! to anyone who has the time, knowledge, and desire to contribute in any
! capacity. Our goals are simply to continue the mission, to improve
! <span class="APPLICATION">Privoxy</span>, and to make it available to as
! wide an audience as possible.</p>
! <p>One does not have to be a programmer to contribute. Packaging,
! testing, documenting and porting, are all important jobs as well.</p>
! <div class="SECT2">
! <h2 class="SECT2"><a name="QUICKSTART" id="QUICKSTART">1.1. Quickstart
! to Privoxy Development</a></h2>
! <p>The first step is to join the <a href=
! "https://lists.privoxy.org/mailman/listinfo/privoxy-devel" target=
! "_top">privoxy-devel mailing list</a>. 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.</p>
! <p>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).</p>
! <p>For the time being (read, this section is under construction), you
! can also refer to the extensive comments in the source code. In fact,
! reading the code is recommended in any case.</p>
</div>
! </div>
! <div class="NAVFOOTER">
! <hr align="left" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top"><a href="index.html"
! accesskey="P">Prev</a></td>
! <td width="34%" align="center" valign="top"><a href="index.html"
! accesskey="H">Home</a></td>
! <td width="33%" align="right" valign="top"><a href="cvs.html"
! accesskey="N">Next</a></td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">Privoxy Developer
! Manual</td>
! <td width="34%" align="center" valign="top"> </td>
! <td width="33%" align="right" valign="top">The CVS Repository</td>
! </tr>
! </table>
! </div>
! </body>
</html>
Index: documentation.html
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/documentation.html,v
retrieving revision 1.46
retrieving revision 1.47
diff -C2 -d -r1.46 -r1.47
*** documentation.html 26 Aug 2016 12:32:48 -0000 1.46
--- documentation.html 12 Jan 2017 14:27:46 -0000 1.47
***************
*** 1,520 ****
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
! Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>
! Documentation Guidelines
! </title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="The CVS Repository" href="cvs.html">
! <link rel="NEXT" title="Coding Guidelines" href="coding.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">
! Privoxy Developer Manual
! </th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom">
! <a href="cvs.html" accesskey="P">Prev</a>
! </td>
! <td width="80%" align="center" valign="bottom">
! </td>
! <td width="10%" align="right" valign="bottom">
! <a href="coding.html" accesskey="N">Next</a>
! </td>
! </tr>
</table>
! <hr align="LEFT" width="100%">
</div>
! <div class="SECT1">
! <h1 class="SECT1">
! <a name="DOCUMENTATION">3. Documentation Guidelines</a>
! </h1>
! <p>
! All formal documents are maintained in Docbook SGML and located in
! the <samp class="COMPUTEROUTPUT">doc/source/*</samp> directory. You
! will need <a href="http://www.docbook.org" target="_top">Docbook</a>,
! the Docbook DTD's and the Docbook modular stylesheets (or comparable
! alternatives), and either <span class="APPLICATION">jade</span> or
! <span class="APPLICATION">openjade</span> (recommended) installed in
! order to build docs from source. Currently there is <a href=
! "../user-manual/index.html" target="_top"><i class=
! "CITETITLE">user-manual</i></a>, <a href="../faq/index.html" target=
! "_top"><i class="CITETITLE">FAQ</i></a>, and, of course this, the <i
! class="CITETITLE">developer-manual</i> in this format. The <i class=
! "CITETITLE">README</i>, <i class="CITETITLE">AUTHORS</i>, <i class=
! "CITETITLE">INSTALL</i>, <i class="CITETITLE">privoxy.1</i> (man
! page), and <i class="CITETITLE">config</i> files are also now
! maintained as Docbook SGML. These files, when built, in the top-level
! source directory are generated files! Also, the <span class=
! "APPLICATION">Privoxy</span> <tt class="FILENAME">index.html</tt>
! (and a variation on this file, <tt class=
! "FILENAME">privoxy-index.html</tt>, meant for inclusion with doc
! packages), are maintained as SGML as well. <span class="emphasis"><i
! class="EMPHASIS">DO NOT edit these directly</i></span>. Edit the SGML
! source, or contact someone involved in the documentation.
! </p>
! <p>
! <tt class="FILENAME">config</tt> requires some special handling. The
! reason it is maintained this way is so that the extensive comments in
! the file mirror those in <i class="CITETITLE">user-manual</i>. But
! the conversion process requires going from SGML to HTML to text to
! special formatting required for the embedded comments. Some of this
! does not survive so well. Especially some of the examples that are
! longer than 80 characters. The build process for this file outputs to
! <tt class="FILENAME">config.new</tt>, which should be reviewed for
! errors and mis-formatting. Once satisfied that it is correct, then it
! should be hand copied to <tt class="FILENAME">config</tt>.
! </p>
! <p>
! Other, less formal documents (e.g. <tt class="FILENAME">LICENSE</tt>)
! are maintained as plain text files in the top-level source directory.
! </p>
! <p>
! 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 <tt
! class="FILENAME">doc/webserver/*</tt>.
! </p>
! <p>
! Formal documents are built with the Makefile targets of <samp class=
! "COMPUTEROUTPUT">make dok</samp>. The build process uses the document
! SGML sources in <samp class="COMPUTEROUTPUT">doc/source/*/*</samp> to
! update all text files in <samp class=
! "COMPUTEROUTPUT">doc/text/</samp> and to update all HTML documents in
! <samp class="COMPUTEROUTPUT">doc/webserver/</samp>.
! </p>
! <p>
! Documentation writers should please make sure documents build
! successfully before committing to CVS, if possible.
! </p>
! <p>
! How do you update the webserver (i.e. the pages on privoxy.org)?
! </p>
! <ol type="1">
<li>
! <p>
! First, build the docs by running <samp class=
! "COMPUTEROUTPUT">make dok</samp>.
! </p>
</li>
<li>
! <p>
! Run <samp class="COMPUTEROUTPUT">make webserver</samp> which
! copies all files from <samp class=
! "COMPUTEROUTPUT">doc/webserver</samp> to the sourceforge
! webserver via scp.
! </p>
! </li>
! </ol>
!
! <p>
! Finished docs should be occasionally submitted to CVS (<tt class=
! "FILENAME">doc/webserver/*/*.html</tt>) so that those without the
! ability to build them locally, have access to them if needed. This is
! especially important just prior to a new release! Please do this
! <span class="emphasis"><i class="EMPHASIS">after</i></span> the <tt
! class="LITERAL">$VERSION</tt> and other release specific data in <tt
! class="FILENAME">configure.in</tt> has been updated (this is done
! just prior to a new release).
! </p>
! <div class="SECT2">
! <h2 class="SECT2">
! <a name="SGML">3.1. Quickstart to Docbook and SGML</a>
! </h2>
! <p>
! If you are not familiar with SGML, it is a markup language similar
! to HTML. Actually, not a mark up language per se, but a language
! used to define markup languages. In fact, HTML is an SGML
! application. Both will use <span class="QUOTE">"tags"</span> to
! format text and other content. SGML tags can be much more varied,
! and flexible, but do much of the same kinds of things. The tags, or
! <span class="QUOTE">"elements"</span>, are definable in SGML. There
! is no set <span class="QUOTE">"standards"</span>. Since we are
! using <span class="APPLICATION">Docbook</span>, our tags are those
! that are defined by <span class="APPLICATION">Docbook</span>. Much
! of how the finish document is rendered is determined by the <span
! class="QUOTE">"stylesheets"</span>. The stylesheets determine how
! each tag gets translated to HTML, or other formats.
! </p>
! <p>
! Tags in Docbook SGML need to be always <span class=
! "QUOTE">"closed"</span>. If not, you will likely generate errors.
! Example: <tt class="LITERAL"><title>My
! Title</title></tt>. They are also case-insensitive, but we
! strongly suggest using all lower case. This keeps compatibility
! with [Docbook] <span class="APPLICATION">XML</span>.
! </p>
! <p>
! Our documents use <span class="QUOTE">"sections"</span> for the
! most part. Sections will be processed into HTML headers (e.g. <tt
! class="LITERAL">h1</tt> for <tt class="LITERAL">sect1</tt>). The
! <span class="APPLICATION">Docbook</span> stylesheets will use these
! to also generate the Table of Contents for each doc. Our TOC's are
! set to a depth of three. Meaning <tt class="LITERAL">sect1</tt>,
! <tt class="LITERAL">sect2</tt>, and <tt class="LITERAL">sect3</tt>
! will have TOC entries, but <tt class="LITERAL">sect4</tt> will not.
! Each section requires a <tt class="LITERAL"><title></tt>
! element, and at least one <tt class="LITERAL"><para></tt>.
! There is a limit of five section levels in Docbook, but generally
! three should be sufficient for our purposes.
! </p>
! <p>
! Some common elements that you likely will use:
! </p>
! <p>
! </p>
! <table border="0">
! <tbody>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS"><para></para></i></span>, paragraph
! delimiter. Most text needs to be within paragraph elements
! (there are some exceptions).
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS"><emphasis></emphasis></i></span>, the
! stylesheets make this italics.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS"><filename></filename></i></span>,
! files and directories.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS"><command></command></i></span>,
! command examples.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS"><literallayout></literallayout></i></span>,
! like <tt class="LITERAL"><pre></tt>, more or less.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS"><itemizedlist></itemizedlist></i></span>,
! list with bullets.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS"><listitem></listitem></i></span>,
! member of the above.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS"><screen></screen></i></span>, screen
! output, implies <tt class=
! "LITERAL"><literallayout></tt>.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class="EMPHASIS"><ulink
! url="example.com"></ulink></i></span>, like HTML <tt
! class="LITERAL"><a></tt> tag.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS"><quote></quote></i></span>, for, doh,
! quoting text.
! </td>
! </tr>
! </tbody>
! </table>
!
! <p>
! Look at any of the existing docs for examples of all these and
! more.
! </p>
! <p>
! You might also find <span class="QUOTE">"<a href=
! "http://opensource.bureau-cornavin.com/crash-course/index.html"
! target="_top">Writing Documentation Using DocBook - A Crash
! Course</a>"</span> useful.
! </p>
! </div>
! <div class="SECT2">
! <h2 class="SECT2">
! <a name="DOCSTYLE">3.2. <span class="APPLICATION">Privoxy</span>
! Documentation Style</a>
! </h2>
! <p>
! It will be easier if everyone follows a similar writing style. This
! just makes it easier to read what someone else has written if it is
! all done in a similar fashion.
! </p>
! <p>
! Here it is:
! </p>
! <p>
! </p>
! <ul>
! <li>
! <p>
! All tags should be lower case.
! </p>
! </li>
! <li>
! <p>
! Tags delimiting a <span class="emphasis"><i class=
! "EMPHASIS">block</i></span> of text (even small blocks) should
! be on their own line. Like:
! </p>
! <p class="LITERALLAYOUT">
! <para><br>
! Some text goes here.<br>
! </para><br>
!
! </p>
! Tags marking individual words, or few words, should be in-line:
! <p class="LITERALLAYOUT">
! Just to <emphasis>emphasize</emphasis>, some text goes here.<br>
!
!
! </p>
! </li>
! <li>
! <p>
! Tags should be nested and step indented for block text like:
! (except in-line tags)
! </p>
! <p class="LITERALLAYOUT">
! <para><br>
! <itemizedlist><br>
! <para><br>
! <listitem><br>
! Some text goes here in our list example.<br>
! </listitem><br>
! </para><br>
! </itemizedlist><br>
! </para><br>
!
! </p>
! This makes it easier to find the text amongst the tags ;-)<br>
! </li>
! <li>
! <p>
! Use white space to separate logical divisions within a
! document, like between sections. Running everything together
! consistently makes it harder to read and work on.
! </p>
! </li>
! <li>
! <p>
! Do not hesitate to make comments. Comments can either use the
! <comment> element, or the <!-- --> style comment
! familiar from HTML. (Note in Docbook v4.x <comment> is
! replaced by <remark>.)
! </p>
! </li>
! <li>
! <p>
! We have an international audience. Refrain from slang, or
! English idiosyncrasies (too many to list :). Humor also does
! not translate well sometimes.
! </p>
! </li>
! <li>
! <p>
! Try to keep overall line lengths in source files to 80
! characters or less for obvious reasons. This is not always
! possible, with lengthy URLs for instance.
! </p>
! </li>
! <li>
! <p>
! Our documents are available in differing formats. Right now,
! they are just plain text and/or HTML, but others are always a
! future possibility. Be careful with URLs (<ulink>), and
! avoid this mistake:
! </p>
! <p>
! My favorite site is <ulink
! url="http://example.com">here</ulink>.
! </p>
! <p>
! This will render as <span class="QUOTE">"My favorite site is
! here"</span>, which is not real helpful in a text doc. Better
! like this:
! </p>
! <p>
! My favorite site is <ulink
! url="http://example.com">example.com</ulink>.
! </p>
! </li>
! <li>
! <p>
! All documents should be spell checked occasionally. <span
! class="APPLICATION">aspell</span> can check SGML with the <tt
! class="LITERAL">-H</tt> option. (<span class=
! "APPLICATION">ispell</span> I think too.)
! </p>
! </li>
! </ul>
! </div>
! <div class="SECT2">
! <h2 class="SECT2">
! <a name="AEN207">3.3. Privoxy Custom Entities</a>
! </h2>
! <p>
! <span class="APPLICATION">Privoxy</span> documentation is using a
! number of customized <span class="QUOTE">"entities"</span> to
! facilitate documentation maintenance.
! </p>
! <p>
! We are using a set of <span class="QUOTE">"boilerplate"</span>
! files with generic text, that is used by multiple docs. This way we
! can write something once, and use it repeatedly without having to
! re-write the same content over and over again. If editing such a
! file, keep in mind that it should be <span class="emphasis"><i
! class="EMPHASIS">generic</i></span>. That is the purpose; so it can
! be used in varying contexts without additional modifications.
! </p>
! <p>
! We are also using what <span class="APPLICATION">Docbook</span>
! calls <span class="QUOTE">"internal entities"</span>. These are
! like variables in programming. Well, sort of. For instance, we have
! the <tt class="LITERAL">p-version</tt> entity that contains the
! current <span class="APPLICATION">Privoxy</span> version string.
! You are strongly encouraged to use these where possible. Some of
! these obviously require re-setting with each release (done by the
! Makefile). A sampling of custom entities are listed below. See any
! of the main docs for examples.
! </p>
! <p>
! </p>
! <ul>
! <li>
! <p>
! Re- <span class="QUOTE">"boilerplate"</span> text entities are
! defined like:
! </p>
! <p>
! <tt class="LITERAL"><!entity supported SYSTEM
! "supported.sgml"></tt>
! </p>
! <p>
! In this example, the contents of the file, <tt class=
! "FILENAME">supported.sgml</tt> is available for inclusion
! anywhere in the doc. To make this happen, just reference the
! now defined entity: <tt class="LITERAL">&supported;</tt>
! (starts with an ampersand and ends with a semi-colon), and the
! contents will be dumped into the finished doc at that point.
! </p>
! </li>
! <li>
! <p>
! Commonly used <span class="QUOTE">"internal entities"</span>:
! </p>
! <table border="0">
! <tbody>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS">p-version</i></span>: the <span class=
! "APPLICATION">Privoxy</span> version string, e.g. <span
! class="QUOTE">"3.0.26"</span>.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS">p-status</i></span>: the project status,
! either <span class="QUOTE">"alpha"</span>, <span class=
! "QUOTE">"beta"</span>, or <span class=
! "QUOTE">"stable"</span>.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS">p-not-stable</i></span>: use to conditionally
! include text in <span class="QUOTE">"not stable"</span>
! releases (e.g. <span class="QUOTE">"beta"</span>).
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS">p-stable</i></span>: just the opposite.
! </td>
! </tr>
! <tr>
! <td>
! <span class="emphasis"><i class=
! "EMPHASIS">p-text</i></span>: this doc is only generated
! as text.
! </td>
! </tr>
! </tbody>
! </table>
! </li>
! </ul>
! <p>
! There are others in various places that are defined for a specific
! purpose. Read the source!
! </p>
! </div>
</div>
! <div class="NAVFOOTER">
! <hr align="LEFT" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top">
! <a href="cvs.html" accesskey="P">Prev</a>
! </td>
! <td width="34%" align="center" valign="top">
! <a href="index.html" accesskey="H">Home</a>
! </td>
! <td width="33%" align="right" valign="top">
! <a href="coding.html" accesskey="N">Next</a>
! </td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">
! The CVS Repository
! </td>
! <td width="34%" align="center" valign="top">
!
! </td>
! <td width="33%" align="right" valign="top">
! Coding Guidelines
! </td>
! </tr>
! </table>
</div>
! </body>
</html>
-
--- 1,379 ----
! <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
! "http://www.w3.org/TR/html4/loose.dtd">
<html>
! <head>
! <title>Documentation Guidelines</title>
! <meta name="GENERATOR" content=
! "Modular DocBook HTML Stylesheet Version 1.79">
! <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
! <link rel="PREVIOUS" title="The CVS Repository" href="cvs.html">
! <link rel="NEXT" title="Coding Guidelines" href="coding.html">
! <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
! <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
! </head>
! <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
! "#840084" alink="#0000FF">
! <div class="NAVHEADER">
! <table summary="Header navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <th colspan="3" align="center">Privoxy Developer Manual</th>
! </tr>
! <tr>
! <td width="10%" align="left" valign="bottom"><a href="cvs.html"
! accesskey="P">Prev</a></td>
! <td width="80%" align="center" valign="bottom"></td>
! <td width="10%" align="right" valign="bottom"><a href="coding.html"
! accesskey="N">Next</a></td>
! </tr>
! </table>
! <hr align="left" width="100%">
! </div>
! <div class="SECT1">
! <h1 class="SECT1"><a name="DOCUMENTATION" id="DOCUMENTATION">3.
! Documentation Guidelines</a></h1>
! <p>All formal documents are maintained in Docbook SGML and located in the
! <samp class="COMPUTEROUTPUT">doc/source/*</samp> directory. You will need
! <a href="http://www.docbook.org" target="_top">Docbook</a>, the Docbook
! DTD's and the Docbook modular stylesheets (or comparable alternatives),
! and either <span class="APPLICATION">jade</span> or <span class=
! "APPLICATION">openjade</span> (recommended) installed in order to build
! docs from source. Currently there is <a href="../user-manual/index.html"
! target="_top"><i class="CITETITLE">user-manual</i></a>, <a href=
! "../faq/index.html" target="_top"><i class="CITETITLE">FAQ</i></a>, and,
! of course this, the <i class="CITETITLE">developer-manual</i> in this
! format. The <i class="CITETITLE">README</i>, <i class=
! "CITETITLE">AUTHORS</i>, <i class="CITETITLE">INSTALL</i>, <i class=
! "CITETITLE">privoxy.1</i> (man page), and <i class="CITETITLE">config</i>
! files are also now maintained as Docbook SGML. These files, when built,
! in the top-level source directory are generated files! Also, the
! <span class="APPLICATION">Privoxy</span> <tt class=
! "FILENAME">index.html</tt> (and a variation on this file, <tt class=
! "FILENAME">privoxy-index.html</tt>, meant for inclusion with doc
! packages), are maintained as SGML as well. <span class=
! "emphasis"><i class="EMPHASIS">DO NOT edit these directly</i></span>.
! Edit the SGML source, or contact someone involved in the
! documentation.</p>
! <p><tt class="FILENAME">config</tt> requires some special handling. The
! reason it is maintained this way is so that the extensive comments in the
! file mirror those in <i class="CITETITLE">user-manual</i>. But the
! conversion process requires going from SGML to HTML to text to special
! formatting required for the embedded comments. Some of this does not
! survive so well. Especially some of the examples that are longer than 80
! characters. The build process for this file outputs to <tt class=
! "FILENAME">config.new</tt>, which should be reviewed for errors and
! mis-formatting. Once satisfied that it is correct, then it should be hand
! copied to <tt class="FILENAME">config</tt>.</p>
! <p>Other, less formal documents (e.g. <tt class="FILENAME">LICENSE</tt>)
! are maintained as plain text files in the top-level source directory.</p>
! <p>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 <tt class=
! "FILENAME">doc/webserver/*</tt>.</p>
! <p>Formal documents are built with the Makefile targets of <samp class=
! "COMPUTEROUTPUT">make dok</samp>. The build process uses the document
! SGML sources in <samp class="COMPUTEROUTPUT">doc/source/*/*</samp> to
! update all text files in <samp class="COMPUTEROUTPUT">doc/text/</samp>
! and to update all HTML documents in <samp class=
! "COMPUTEROUTPUT">doc/webserver/</samp>.</p>
! <p>Documentation writers should please make sure documents build
! successfully before committing to CVS, if possible.</p>
! <p>How do you update the webserver (i.e. the pages on privoxy.org)?</p>
! <ol type="1">
! <li>
! <p>First, build the docs by running <samp class="COMPUTEROUTPUT">make
! dok</samp>.</p>
! </li>
! <li>
! <p>Run <samp class="COMPUTEROUTPUT">make webserver</samp> which
! copies all files from <samp class=
! "COMPUTEROUTPUT">doc/webserver</samp> to the sourceforge webserver
! via scp.</p>
! </li>
! </ol>
! <p>Finished docs should be occasionally submitted to CVS (<tt class=
! "FILENAME">doc/webserver/*/*.html</tt>) so that those without the ability
! to build them locally, have access to them if needed. This is especially
! important just prior to a new release! Please do this <span class=
! "emphasis"><i class="EMPHASIS">after</i></span> the <tt class=
! "LITERAL">$VERSION</tt> and other release specific data in <tt class=
! "FILENAME">configure.in</tt> has been updated (this is done just prior to
! a new release).</p>
! <div class="SECT2">
! <h2 class="SECT2"><a name="SGML" id="SGML">3.1. Quickstart to Docbook
! and SGML</a></h2>
! <p>If you are not familiar with SGML, it is a markup language similar
! to HTML. Actually, not a mark up language per se, but a language used
! to define markup languages. In fact, HTML is an SGML application. Both
! will use <span class="QUOTE">"tags"</span> to format text and other
! content. SGML tags can be much more varied, and flexible, but do much
! of the same kinds of things. The tags, or <span class=
! "QUOTE">"elements"</span>, are definable in SGML. There is no set
! <span class="QUOTE">"standards"</span>. Since we are using <span class=
! "APPLICATION">Docbook</span>, our tags are those that are defined by
! <span class="APPLICATION">Docbook</span>. Much of how the finish
! document is rendered is determined by the <span class=
! "QUOTE">"stylesheets"</span>. The stylesheets determine how each tag
! gets translated to HTML, or other formats.</p>
! <p>Tags in Docbook SGML need to be always <span class=
! "QUOTE">"closed"</span>. If not, you will likely generate errors.
! Example: <tt class="LITERAL"><title>My Title</title></tt>.
! They are also case-insensitive, but we strongly suggest using all lower
! case. This keeps compatibility with [Docbook] <span class=
! "APPLICATION">XML</span>.</p>
! <p>Our documents use <span class="QUOTE">"sections"</span> for the most
! part. Sections will be processed into HTML headers (e.g. <tt class=
! "LITERAL">h1</tt> for <tt class="LITERAL">sect1</tt>). The <span class=
! "APPLICATION">Docbook</span> stylesheets will use these to also
! generate the Table of Contents for each doc. Our TOC's are set to a
! depth of three. Meaning <tt class="LITERAL">sect1</tt>, <tt class=
! "LITERAL">sect2</tt>, and <tt class="LITERAL">sect3</tt> will have TOC
! entries, but <tt class="LITERAL">sect4</tt> will not. Each section
! requires a <tt class="LITERAL"><title></tt> element, and at least
! one <tt class="LITERAL"><para></tt>. There is a limit of five
! section levels in Docbook, but generally three should be sufficient for
! our purposes.</p>
! <p>Some common elements that you likely will use:</p>
! <table border="0">
! <tbody>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS"><para></para></i></span>, paragraph
! delimiter. Most text needs to be within paragraph elements (there
! are some exceptions).</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS"><emphasis></emphasis></i></span>, the
! stylesheets make this italics.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS"><filename></filename></i></span>, files
! and directories.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS"><command></command></i></span>, command
! examples.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS"><literallayout></literallayout></i></span>,
! like <tt class="LITERAL"><pre></tt>, more or less.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS"><itemizedlist></itemizedlist></i></span>,
! list with bullets.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS"><listitem></listitem></i></span>, member
! of the above.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS"><screen></screen></i></span>, screen
! output, implies <tt class=
! "LITERAL"><literallayout></tt>.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class="EMPHASIS"><ulink
! url="example.com"></ulink></i></span>, like HTML
! <tt class="LITERAL"><a></tt> tag.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS"><quote></quote></i></span>, for, doh,
! quoting text.</td>
! </tr>
! </tbody>
</table>
! <p>Look at any of the existing docs for examples of all these and
! more.</p>
! <p>You might also find <span class="QUOTE">"<a href=
! "http://opensource.bureau-cornavin.com/crash-course/index.html" target=
! "_top">Writing Documentation Using DocBook - A Crash Course</a>"</span>
! useful.</p>
</div>
! <div class="SECT2">
! <h2 class="SECT2"><a name="DOCSTYLE" id="DOCSTYLE">3.2. <span class=
! "APPLICATION">Privoxy</span> Documentation Style</a></h2>
! <p>It will be easier if everyone follows a similar writing style. This
! just makes it easier to read what someone else has written if it is all
! done in a similar fashion.</p>
! <p>Here it is:</p>
! <ul>
<li>
! <p>All tags should be lower case.</p>
</li>
<li>
! <p>Tags delimiting a <span class="emphasis"><i class=
! "EMPHASIS">block</i></span> of text (even small blocks) should be
! on their own line. Like:</p>
! <p class="LITERALLAYOUT"> <para><br>
! Some text goes here.<br>
! </para><br>
! </p>Tags marking
! individual words, or few words, should be in-line:
! <p class="LITERALLAYOUT">
! Just to <emphasis>emphasize</emphasis>, some text goes here.<br>
! </p>
! </li>
! <li>
! <p>Tags should be nested and step indented for block text like:
! (except in-line tags)</p>
! <p class="LITERALLAYOUT"> <para><br>
! <itemizedlist><br>
! <para><br>
! <listitem><br>
! Some text goes here in our list example.<br>
! </listitem><br>
! </para><br>
! </itemizedlist><br>
! </para><br>
! </p>This makes it easier
! to find the text amongst the tags ;-)
! </li>
! <li>
! <p>Use white space to separate logical divisions within a document,
! like between sections. Running everything together consistently
! makes it harder to read and work on.</p>
! </li>
! <li>
! <p>Do not hesitate to make comments. Comments can either use the
! <comment> element, or the <!-- --> style comment
! familiar from HTML. (Note in Docbook v4.x <comment> is
! replaced by <remark>.)</p>
! </li>
! <li>
! <p>We have an international audience. Refrain from slang, or
! English idiosyncrasies (too many to list :). Humor also does not
! translate well sometimes.</p>
! </li>
! <li>
! <p>Try to keep overall line lengths in source files to 80
! characters or less for obvious reasons. This is not always
! possible, with lengthy URLs for instance.</p>
! </li>
! <li>
! <p>Our documents are available in differing formats. Right now,
! they are just plain text and/or HTML, but others are always a
! future possibility. Be careful with URLs (<ulink>), and avoid
! this mistake:</p>
! <p>My favorite site is <ulink
! url="http://example.com">here</ulink>.</p>
! <p>This will render as <span class="QUOTE">"My favorite site is
! here"</span>, which is not real helpful in a text doc. Better like
! this:</p>
! <p>My favorite site is <ulink
! url="http://example.com">example.com</ulink>.</p>
! </li>
! <li>
! <p>All documents should be spell checked occasionally. <span class=
! "APPLICATION">aspell</span> can check SGML with the <tt class=
! "LITERAL">-H</tt> option. (<span class="APPLICATION">ispell</span>
! I think too.)</p>
! </li>
! </ul>
</div>
! <div class="SECT2">
! <h2 class="SECT2"><a name="AEN207" id="AEN207">3.3. Privoxy Custom
! Entities</a></h2>
! <p><span class="APPLICATION">Privoxy</span> documentation is using a
! number of customized <span class="QUOTE">"entities"</span> to
! facilitate documentation maintenance.</p>
! <p>We are using a set of <span class="QUOTE">"boilerplate"</span> files
! with generic text, that is used by multiple docs. This way we can write
! something once, and use it repeatedly without having to re-write the
! same content over and over again. If editing such a file, keep in mind
! that it should be <span class="emphasis"><i class=
! "EMPHASIS">generic</i></span>. That is the purpose; so it can be used
! in varying contexts without additional modifications.</p>
! <p>We are also using what <span class="APPLICATION">Docbook</span>
! calls <span class="QUOTE">"internal entities"</span>. These are like
! variables in programming. Well, sort of. For instance, we have the
! <tt class="LITERAL">p-version</tt> entity that contains the current
! <span class="APPLICATION">Privoxy</span> version string. You are
! strongly encouraged to use these where possible. Some of these
! obviously require re-setting with each release (done by the Makefile).
! A sampling of custom entities are listed below. See any of the main
! docs for examples.</p>
! <ul>
! <li>
! <p>Re- <span class="QUOTE">"boilerplate"</span> text entities are
! defined like:</p>
! <p><tt class="LITERAL"><!entity supported SYSTEM
! "supported.sgml"></tt></p>
! <p>In this example, the contents of the file, <tt class=
! "FILENAME">supported.sgml</tt> is available for inclusion anywhere
! in the doc. To make this happen, just reference the now defined
! entity: <tt class="LITERAL">&supported;</tt> (starts with an
! ampersand and ends with a semi-colon), and the contents will be
! dumped into the finished doc at that point.</p>
! </li>
! <li>
! <p>Commonly used <span class="QUOTE">"internal
! entities"</span>:</p>
! <table border="0">
! <tbody>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS">p-version</i></span>: the <span class=
! "APPLICATION">Privoxy</span> version string, e.g.
! <span class="QUOTE">"3.0.26"</span>.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS">p-status</i></span>: the project status, either
! <span class="QUOTE">"alpha"</span>, <span class=
! "QUOTE">"beta"</span>, or <span class=
! "QUOTE">"stable"</span>.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS">p-not-stable</i></span>: use to conditionally
! include text in <span class="QUOTE">"not stable"</span>
! releases (e.g. <span class="QUOTE">"beta"</span>).</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS">p-stable</i></span>: just the opposite.</td>
! </tr>
! <tr>
! <td><span class="emphasis"><i class=
! "EMPHASIS">p-text</i></span>: this doc is only generated as
! text.</td>
! </tr>
! </tbody>
! </table>
! </li>
! </ul>
! <p>There are others in various places that are defined for a specific
! purpose. Read the source!</p>
</div>
! </div>
! <div class="NAVFOOTER">
! <hr align="left" width="100%">
! <table summary="Footer navigation table" width="100%" border="0"
! cellpadding="0" cellspacing="0">
! <tr>
! <td width="33%" align="left" valign="top"><a href="cvs.html"
! accesskey="P">Prev</a></td>
! <td width="34%" align="center" valign="top"><a href="index.html"
! accesskey="H">Home</a></td>
! <td width="33%" align="right" valign="top"><a href="coding.html"
! accesskey="N">Next</a></td>
! </tr>
! <tr>
! <td width="33%" align="left" valign="top">The CVS Repository</td>
! <td width="34%" align="center" valign="top"> </td>
! <td width="33%" align="right" valign="top">Coding Guidelines</td>
! </tr>
! </table>
! </div>
! </body>
</html>
------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
_______________________________________________
ijbswa-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/ijbswa-commits