Catch up on recent source changes.
[privoxy.git] / doc / webserver / developer-manual / newrelease.html
index 62721d3..5ff11fb 100644 (file)
@@ -361,15 +361,239 @@ CLASS="EMPHASIS"
     </P
 ><P
 >     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.
     </P
 ><DIV
 CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
+NAME="PACK-GUIDELINES"
+>6.3.1. Note on Privoxy Packaging</A
+></H3
+><P
+>      Please keep these general guidelines in mind when putting together 
+      your package. These apply to <I
+CLASS="EMPHASIS"
+>all</I
+> platforms!
+     </P
+><P
+>      <P
+></P
+><UL
+><LI
+><P
+>          <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> <I
+CLASS="EMPHASIS"
+>requires</I
+>
+          write access to: all <TT
+CLASS="FILENAME"
+>*.action</TT
+> files, all 
+          logfiles, and the <TT
+CLASS="FILENAME"
+>trust</TT
+> file. You will 
+          need to determine the best way to do this for your platform.
+        </P
+></LI
+><LI
+><P
+>          Please include up to date documentation. At a bare minimum:
+        </P
+><P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+>          <TT
+CLASS="FILENAME"
+>LICENSE</TT
+> (toplevel directory)
+         </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+><P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+>          <TT
+CLASS="FILENAME"
+>README</TT
+> (toplevel directory)
+         </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+><P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+>          <TT
+CLASS="FILENAME"
+>AUTHORS</TT
+> (toplevel directory)
+         </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+><P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+>          <TT
+CLASS="FILENAME"
+>man page</TT
+> (toplevel directory, Unix-like
+          platforms only)
+         </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+><P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+>          <TT
+CLASS="FILENAME"
+>The User Manual</TT
+> (doc/webserver/user-manual/)
+         </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+><P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+>          <TT
+CLASS="FILENAME"
+>FAQ</TT
+> (doc/webserver/faq/)
+         </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+><P
+>          Also suggested: <TT
+CLASS="FILENAME"
+>Developer Manual</TT
+>
+          (doc/webserver/devel-manual) and <TT
+CLASS="FILENAME"
+>ChangeLog</TT
+>
+          (toplevel directory). <TT
+CLASS="FILENAME"
+>FAQ</TT
+> and the manuals are
+          HTML docs. There are also text versions in
+          <TT
+CLASS="FILENAME"
+>doc/text/</TT
+> which could conceivably also be
+          included.
+        </P
+><P
+>         The documentation has been designed such that the manuals are linked
+         to each other from parallel directories, and should be packaged 
+         that way. <TT
+CLASS="FILENAME"
+>index.html</TT
+> 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:
+         <TT
+CLASS="FILENAME"
+>p_doc.css</TT
+> and <TT
+CLASS="FILENAME"
+>p_web.css</TT
+>.
+         These should be in the same directory with
+         <TT
+CLASS="FILENAME"
+>index.html</TT
+>, (i.e. one level up from the manual 
+         directories).
+        </P
+></LI
+><LI
+><P
+>        <TT
+CLASS="FILENAME"
+>user.action</TT
+> is designed for local preferences. 
+        Make sure this does not get overwritten!
+       </P
+></LI
+><LI
+><P
+>        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 :-)
+       </P
+></LI
+><LI
+><P
+>       Please check platform specific notes in this doc, if you haven't 
+       done <SPAN
+CLASS="QUOTE"
+>"Privoxy"</SPAN
+> 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).
+      </P
+></LI
+></UL
+>
+     </P
+></DIV
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
 NAME="NEWRELEASE-TARBALL"
->6.3.1. Source Tarball</A
+>6.3.2. Source Tarball</A
 ></H3
 ><P
 >      First, <I
@@ -446,7 +670,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-RPM"
->6.3.2. SuSE or Red Hat RPM</A
+>6.3.3. SuSE, Conectiva or Red Hat RPM</A
 ></H3
 ><P
 >        In following text, replace <TT
@@ -591,7 +815,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-OS2"
->6.3.3. OS/2</A
+>6.3.4. OS/2</A
 ></H3
 ><P
 >      First, <I
@@ -725,7 +949,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-SOLARIS"
->6.3.4. Solaris</A
+>6.3.5. Solaris</A
 ></H3
 ><P
 >      Login to Sourceforge's compilefarm via ssh:
@@ -805,7 +1029,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-WINDOWS"
->6.3.5. Windows</A
+>6.3.6. Windows</A
 ></H3
 ><P
 >        You should ensure you have the latest version of Cygwin (from
@@ -882,7 +1106,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-DEBIAN"
->6.3.6. Debian</A
+>6.3.7. Debian</A
 ></H3
 ><P
 >      First, <I
@@ -918,7 +1142,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-MACOSX"
->6.3.7. Mac OSX</A
+>6.3.8. Mac OSX</A
 ></H3
 ><P
 >      First, <I
@@ -1023,7 +1247,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-FREEBSD"
->6.3.8. FreeBSD</A
+>6.3.9. FreeBSD</A
 ></H3
 ><P
 >      Login to Sourceforge's compilefarm via ssh:
@@ -1103,7 +1327,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-HPUX"
->6.3.9. HP-UX 11</A
+>6.3.10. HP-UX 11</A
 ></H3
 ><P
 >      First, <I
@@ -1139,7 +1363,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-AMIGA"
->6.3.10. Amiga OS</A
+>6.3.11. Amiga OS</A
 ></H3
 ><P
 >      First, <I
@@ -1175,7 +1399,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-AIX"
->6.3.11. AIX</A
+>6.3.12. AIX</A
 ></H3
 ><P
 >      Login to Sourceforge's compilefarm via ssh:
@@ -1296,6 +1520,12 @@ CLASS="LITERAL"
 >
     </P
 ><P
+>     Or use the <B
+CLASS="COMMAND"
+>make</B
+> targets as described above.
+    </P
+><P
 >     Once this done go to <A
 HREF="http://sourceforge.net/project/admin/editpackages.php?group_id=11118"
 TARGET="_top"