From c48cb79d9d0807e21b3b8058441c057c12fe80a1 Mon Sep 17 00:00:00 2001 From: hal9 Date: Sun, 19 May 2002 23:01:54 +0000 Subject: [PATCH] Add small section on general packaging guidelines (e.g. actions files must be writable). --- doc/source/developer-manual.sgml | 112 +++++++++++++++++++++++++++++-- 1 file changed, 108 insertions(+), 4 deletions(-) diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index 89c12642..ce349fd4 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -23,7 +23,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: developer-manual.sgml,v 1.43 2002/05/10 01:48:19 hal9 Exp $ + $Id: developer-manual.sgml,v 1.44 2002/05/15 03:55:17 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -50,7 +50,7 @@ - $Id: developer-manual.sgml,v 1.43 2002/05/10 01:48:19 hal9 Exp $ + $Id: developer-manual.sgml,v 1.44 2002/05/15 03:55:17 hal9 Exp $ ource$ @@ -1786,7 +1786,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.43 2002/05/10 01:48:19 hal9 Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.44 2002/05/15 03:55:17 hal9 Exp $" /********************************************************************* * * File : $Source$ @@ -2123,6 +2123,106 @@ at sourceforge. Three simple steps: 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 @@ -2700,6 +2800,10 @@ 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.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 -- 2.39.2