Rebuild for 3.0.17 stable
[privoxy.git] / doc / webserver / developer-manual / newrelease.html
index a9c3b3e..1787950 100644 (file)
@@ -1,11 +1,11 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<!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.7"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
 TITLE="Privoxy Developer Manual"
 HREF="index.html"><LINK
@@ -17,7 +17,10 @@ TITLE="Update the Webserver"
 HREF="webserver-update.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1"></HEAD
 ><BODY
 CLASS="SECT1"
 BGCOLOR="#EEEEEE"
@@ -174,9 +177,9 @@ CLASS="APPLICATION"
               little to no development happening in such branches. Remember,
               only bugfixes, which presumably should have had some testing
               before being committed. Stable branches will then have their 
-              version reported as <VAR
+              version reported as <TT
 CLASS="LITERAL"
->0.0.0</VAR
+>0.0.0</TT
 >, during that period 
               between releases when changes are being added. This is to denote 
               that this code is <SPAN
@@ -187,9 +190,9 @@ CLASS="EMPHASIS"
 ></SPAN
 >. Then 
               as the release nears, the version is bumped according: e.g. 
-              <VAR
+              <TT
 CLASS="LITERAL"
->3.0.1 -&#62; 0.0.0 -&#62; 3.0.2</VAR
+>3.0.1 -&#62; 0.0.0 -&#62; 3.0.2</TT
 >.
             </P
 ></LI
@@ -201,9 +204,9 @@ CLASS="LITERAL"
      features are being worked on for the next stable series. This should
      almost always be where the most activity takes place. There is always at
      least one stable branch from the trunk, e.g now it is
-     <VAR
+     <TT
 CLASS="LITERAL"
->3.0</VAR
+>3.0</TT
 >, which is only used to release stable versions.
      Once the initial *.0 release of the stable branch has been done, then as a
      rule, only bugfixes that have had prior testing should be committed to
@@ -232,9 +235,9 @@ CLASS="EMPHASIS"
 >and</I
 ></SPAN
 > the stable release branch,
-     which is <VAR
+     which is <TT
 CLASS="LITERAL"
->v_3_0_branch</VAR
+>v_3_0_branch</TT
 > at the moment).
     </P
 ></DIV
@@ -343,9 +346,9 @@ CLASS="CITETITLE"
 >
          link from the main page since we need to keep manuals for various 
          versions available). The CGI pages will link to something like 
-         <VAR
+         <TT
 CLASS="LITERAL"
->http://privoxy.org/$(VERSION)/user-manual/</VAR
+>http://privoxy.org/$(VERSION)/user-manual/</TT
 >. This
          will need to be updated for each new release. There is no Makefile
          target for this at this time!!! It needs to be done manually.
@@ -464,8 +467,8 @@ WIDTH="100%"
 CLASS="PROGRAMLISTING"
 >  mkdir dist # delete or choose different name if it already exists
   cd dist
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</PRE
+  cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
+  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</PRE
 ></TD
 ></TR
 ></TABLE
@@ -483,6 +486,36 @@ CLASS="EMPHASIS"
      all release packages, and with them, all future bug reports, are based
      on exactly the same code.
     </P
+><DIV
+CLASS="WARNING"
+><P
+></P
+><TABLE
+CLASS="WARNING"
+BORDER="1"
+WIDTH="100%"
+><TR
+><TD
+ALIGN="CENTER"
+><B
+>Warning</B
+></TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+><P
+>      Every significant release of Privoxy has included at least one 
+      package that either had incorrect versions of files, missing files, 
+      or incidental leftovers from a previous build process that gave 
+      unknown numbers of users headaches to try to figure out what was 
+      wrong. PLEASE, make sure you are using pristene sources, and are
+      following the prescribed process!
+     </P
+></TD
+></TR
+></TABLE
+></DIV
 ><P
 >     Please find additional instructions for the source tarball and the
      individual platform dependent binary packages below. And details 
@@ -697,15 +730,36 @@ CLASS="FILENAME"
 >        <TT
 CLASS="FILENAME"
 >user.action</TT
-> is designed for local preferences. 
-        Make sure this does not get overwritten!
+> and <TT
+CLASS="FILENAME"
+>user.filter</TT
+>
+        are designed for local preferences. Make sure these do not get overwritten!
+        <TT
+CLASS="FILENAME"
+>config</TT
+> should not be overwritten either. This 
+        has especially important configuration data in it.
+        <TT
+CLASS="FILENAME"
+>trust</TT
+> should be left in tact as well.
        </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 :-)
+>        Other configuration files (<TT
+CLASS="FILENAME"
+>default.action</TT
+> and
+        <TT
+CLASS="FILENAME"
+>default.filter</TT
+>) should be installed as the new
+        defaults, but all previously installed configuration files should be
+        preserved as backups. This is just good manners :-) These files are
+        likely to change between releases and contain important new features
+        and bug fixes.
        </P
 ></LI
 ><LI
@@ -825,9 +879,11 @@ NAME="NEWRELEASE-RPM"
 >6.3.3. SuSE, Conectiva or Red Hat RPM</A
 ></H3
 ><P
->        In following text, replace <VAR
+>        In following text, replace <TT
 CLASS="REPLACEABLE"
->dist</VAR
+><I
+>dist</I
+></TT
 >
         with either <SPAN
 CLASS="QUOTE"
@@ -853,9 +909,11 @@ CLASS="EMPHASIS"
         now examine the file <TT
 CLASS="FILENAME"
 >privoxy-</TT
-><VAR
+><TT
 CLASS="REPLACEABLE"
->dist</VAR
+><I
+>dist</I
+></TT
 ><TT
 CLASS="FILENAME"
 >.spec</TT
@@ -863,9 +921,11 @@ CLASS="FILENAME"
         and make sure that the version information and the RPM release number are
         correct. The RPM release numbers for each version start at one. Hence it must
         be reset to one if this is the first RPM for
-        <VAR
+        <TT
 CLASS="REPLACEABLE"
->dist</VAR
+><I
+>dist</I
+></TT
 > which is built from version
         X.Y.Z. Check the
         <A
@@ -907,9 +967,11 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="PROGRAMLISTING"
->  make <VAR
+>  make <TT
 CLASS="REPLACEABLE"
->dist</VAR
+><I
+>dist</I
+></TT
 >-dist</PRE
 ></TD
 ></TR
@@ -928,12 +990,16 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="PROGRAMLISTING"
->  make <VAR
+>  make <TT
 CLASS="REPLACEABLE"
->dist</VAR
->-upload <VAR
+><I
+>dist</I
+></TT
+>-upload <TT
 CLASS="REPLACEABLE"
->rpm_packagerev</VAR
+><I
+>rpm_packagerev</I
+></TT
 ></PRE
 ></TD
 ></TR
@@ -941,9 +1007,11 @@ CLASS="REPLACEABLE"
 >
        </P
 ><P
->        where <VAR
+>        where <TT
 CLASS="REPLACEABLE"
->rpm_packagerev</VAR
+><I
+>rpm_packagerev</I
+></TT
 > is the
         RPM release number as determined above.
        Go to the displayed URL and release the file publicly on Sourceforge.
@@ -978,7 +1046,7 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="PROGRAMLISTING"
->  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
+>  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
 ></TD
 ></TR
 ></TABLE
@@ -1207,7 +1275,7 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="PROGRAMLISTING"
->  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup</PRE
+>  cvs -z3  -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup</PRE
 ></TD
 ></TR
 ></TABLE
@@ -1283,7 +1351,7 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="PROGRAMLISTING"
->  debchange -v 3.0.3-stable-1 "New upstream version"</PRE
+>  debchange -v 3.0.17-stable-1 "New upstream version"</PRE
 ></TD
 ></TR
 ></TABLE
@@ -1311,7 +1379,7 @@ CLASS="PROGRAMLISTING"
 >        This will create
         <TT
 CLASS="FILENAME"
->../privoxy_3.0.3-stable-1_i386.deb</TT
+>../privoxy_3.0.17-stable-1_i386.deb</TT
 >
         which can be uploaded.  To upload the package to Sourceforge, simply
        issue
@@ -1338,7 +1406,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="NEWRELEASE-MACOSX"
->6.3.8. Mac OSX</A
+>6.3.8. Mac OS X</A
 ></H3
 ><P
 >      First, <SPAN
@@ -1349,7 +1417,7 @@ CLASS="EMPHASIS"
         version into an empty directory</I
 ></SPAN
 >. (See "Building and releasing
-        packages" above). Then get the Mac OSX setup module:
+        packages" above). Then get the Mac OS X setup module:
        </P
 ><P
 >      <TABLE
@@ -1360,7 +1428,7 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="PROGRAMLISTING"
->  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
+>  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
 ></TD
 ></TR
 ></TABLE
@@ -1713,17 +1781,17 @@ TARGET="_top"
 ></LI
 ><LI
 ><P
->         user: <VAR
+>         user: <TT
 CLASS="LITERAL"
->anonymous</VAR
+>anonymous</TT
 >
        </P
 ></LI
 ><LI
 ><P
->         password: <VAR
+>         password: <TT
 CLASS="LITERAL"
->ijbswa-developers@lists.sourceforge.net</VAR
+>ijbswa-developers@lists.sourceforge.net</TT
 >
        </P
 ></LI
@@ -1738,24 +1806,24 @@ CLASS="COMMAND"
     </P
 ><P
 >     Once this done go to <A
-HREF="http://sourceforge.net/project/admin/editpackages.php?group_id=11118"
+HREF="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
 TARGET="_top"
->http://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
+>https://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
 >, 
      making sure you are logged in. Find your target platform in the 
-     second column, and click <VAR
+     second column, and click <TT
 CLASS="LITERAL"
->Add Release</VAR
+>Add Release</TT
 >. You will 
      then need to create a new release for your package, using the format 
-     of <VAR
+     of <TT
 CLASS="LITERAL"
->$VERSION ($CODE_STATUS)</VAR
+>$VERSION ($CODE_STATUS)</TT
 >, e.g. <SPAN
 CLASS="emphasis"
 ><I
 CLASS="EMPHASIS"
->3.0.3
+>3.0.17
      (beta)</I
 ></SPAN
 >.
@@ -1786,13 +1854,13 @@ CLASS="QUOTE"
     </P
 ><P
 >     If you have made errors, or need to make changes, you can go through 
-     essentially the same steps, but select <VAR
+     essentially the same steps, but select <TT
 CLASS="LITERAL"
->Edit Release</VAR
+>Edit Release</TT
 >, 
-     instead of <VAR
+     instead of <TT
 CLASS="LITERAL"
->Add Release</VAR
+>Add Release</TT
 >.
     </P
 ></DIV
@@ -1820,7 +1888,8 @@ TARGET="_top"
       location</A
 >, the release notes and the Changelog. Also, post an
       updated News item on the project page Sourceforge, and update the Home 
-      page and docs linked from the Home page (see below).
+      page and docs linked from the Home page (see below). Other news sites
+      and release oriented sites, such as Freshmeat, should also be notified.
      </P
 ></DIV
 ></DIV
@@ -1884,4 +1953,4 @@ VALIGN="top"
 ></DIV
 ></BODY
 ></HTML
->
\ No newline at end of file
+>