X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fdeveloper-manual.sgml;h=5049edd95b7066b1f506ab2a67097fe93b359246;hb=40f1317bc310955b90b71ac41d8e2fb1fde49d3c;hp=995537fbf1dd6fdce705a8c6bb097dced44848c8;hpb=dba8f7af29bf74adfddba866b9f35a015ec83ddf;p=privoxy.git
diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index 995537fb..5049edd9 100644
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -7,12 +7,14 @@
-
+
+
+
]>
+
+ Copyright &my-copy; 2001, 2002 by
+ Privoxy Developers
+
+
+
- $Id: developer-manual.sgml,v 1.38 2002/04/29 02:20:31 hal9 Exp $
+ $Id: developer-manual.sgml,v 1.45 2002/05/19 23:01:54 hal9 Exp $
+
+
+
@@ -65,10 +81,11 @@
]]>
- The developer manual gives the users information on how to help the developer
- team. It provides guidance on coding, testing, documentation and other
- issues.
-
+ The developer manual provides guidance on coding, testing, packaging, documentation
+ and other issues of importance to those involved with
+ Privoxy development. It is mandatory (and helpful!) reading
+ for anyone who wants to join the team.
+
@@ -80,10 +97,9 @@
You can find the latest version of the this manual at http://www.privoxy.org/developer-manual/.
- Please see the Contact section
+ Please see the Contact section
on how to contact the developers.
-
@@ -91,18 +107,9 @@
-
-
-
-
-
-
-
-
-
- Introduction
+ Introduction
- Quickstart to Privoxy Development
+ Quickstart to Privoxy Development
You'll need an account on Sourceforge to support our
@@ -136,6 +142,7 @@
For the time being (read, this section is under construction), please
refer to the extensive comments in the source code.
+
@@ -1720,7 +1727,7 @@ static void unload_re_filterfile( void *f ) { ... }
Example for file comments:
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.38 2002/04/29 02:20:31 hal9 Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.45 2002/05/19 23:01:54 hal9 Exp $";
/*********************************************************************
*
* File : $Source$
@@ -1780,7 +1787,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.38 2002/04/29 02:20:31 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.45 2002/05/19 23:01:54 hal9 Exp $"
/*********************************************************************
*
* File : $Source$
@@ -2113,9 +2120,110 @@ at sourceforge. Three simple steps:
Please find additional instructions for the source tarball and the
- individual platform dependent binary packages below.
+ individual platform dependent binary packages below. And details
+ on the Sourceforge release process below that.
+
+ Note on Privoxy Packaging
+
+ Please keep these general guidelines in mind when putting together
+ your package. These apply to all platforms!
+
+
+
+
+
+ Privoxy requires
+ write access to: all *.action files, all
+ logfiles, and the trust file. You will
+ need to determine the best way to do this for your platform.
+
+
+
+
+ Please include up to date documentation. At a bare minimum:
+
+
+
+ LICENSE (toplevel directory)
+
+
+
+
+ README (toplevel directory)
+
+
+
+
+ AUTHORS (toplevel directory)
+
+
+
+
+ man page (toplevel directory, Unix-like
+ platforms only)
+
+
+
+
+ The User Manual (doc/webserver/user-manual/)
+
+
+
+
+ FAQ (doc/webserver/faq/)
+
+
+
+ Also suggested: Developer Manual
+ (doc/webserver/devel-manual) and ChangeLog
+ (toplevel directory). FAQ and the manuals are
+ HTML docs. There are also text versions in
+ doc/text/ which could conceivably also be
+ included.
+
+
+ The documentation has been designed such that the manuals are linked
+ to each other from parallel directories, and should be packaged
+ that way. index.html can also be included and
+ can serve as a focal point for docs and other links of interest.
+ This should be one level up from the manuals. There are two
+ css stylesheets that can be included for better presentation:
+ p_doc.css and p_web.css.
+ These should be in the same directory with
+ index.html, (i.e. one level up from the manual
+ directories).
+
+
+
+
+ user.action is designed for local preferences.
+ Make sure this does not get overwritten!
+
+
+
+
+ Other configuration files should be installed as the new defaults,
+ but all previously installed configuration files should be preserved
+ as backups. This is just good manners :-)
+
+
+
+
+ Please check platform specific notes in this doc, if you haven't
+ done Privoxy
packaging before for other platform
+ specific issues. Conversely, please add any notes that you know
+ are important for your platform (or contact one of the doc
+ maintainers to do this if you can't).
+
+
+
+
+
+
+
+
Source Tarball
First, make sure that you have freshly exported the right
@@ -2151,7 +2259,7 @@ at sourceforge. Three simple steps:
- SuSE or Red Hat RPM
+ SuSE, Conectiva or Red Hat RPM
In following text, replace dist
with either rh
for Red Hat or suse
for SuSE.
@@ -2535,6 +2643,9 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
+
+ Or use the make targets as described above.
+
Once this done go to http://sourceforge.net/project/admin/editpackages.php?group_id=11118,
making sure you are logged in. Find your target platform in the
@@ -2636,22 +2747,30 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
-
- Copyright and History
-Copyright
+
+Privoxy Copyright, License and History
+
©right;
+
+
+License
+
+ &license;
+
+
+
History
&history;
-
+
See also
@@ -2682,6 +2801,32 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: developer-manual.sgml,v $
+ Revision 1.45 2002/05/19 23:01:54 hal9
+ Add small section on general packaging guidelines (e.g. actions files must
+ be writable).
+
+ Revision 1.44 2002/05/15 03:55:17 hal9
+ Fix ulink -> link, and minor modification to release process section for
+ clarification.
+
+ Revision 1.43 2002/05/10 01:48:19 hal9
+ This is mostly proposed copyright/licensing additions and changes. Docs
+ are still GPL, but licensing and copyright are more visible. Also, copyright
+ changed in doc header comments (eliminate references to JB except FAQ).
+
+ Revision 1.42 2002/05/05 20:26:02 hal9
+ Sorting out license vs copyright in these docs.
+
+ Revision 1.41 2002/05/04 08:44:44 swa
+ bumped version
+
+ Revision 1.40 2002/05/04 00:43:43 hal9
+ -Remove TOC/first page kludge with proper stylesheet fix.
+ -Combined the two very brief sections: Intro and Quickstart.
+
+ Revision 1.39 2002/05/02 15:08:25 oes
+ Added explanation about version numbers and RPM package revisions
+
Revision 1.38 2002/04/29 02:20:31 hal9
Add info on steps for uploading and the release process on SF.