"Before the Release" requires more than just "Freeze"

[privoxy.git] / doc / source / developer-manual.sgml

diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index 9a4fe6d..cfd0f30 100644 (file)
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -2139,7 +2139,7 @@ $ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla.
     </sect2>
 
     <sect2 id="beforerelease">
-    <title>Before the Release: Freeze</title>
+    <title>Before the Release</title>
      <para>
        The following <emphasis>must be done by one of the
        developers</emphasis> prior to each new release.
@@ -2189,7 +2189,55 @@ for-privoxy-version=3.0.11
       </listitem>
       <listitem>
        <para>
-        All documentation should be rebuild after the code status has been changed.
+        Create the change log:
+       </para>
+       <programlisting>
+  $ git tag
+  #   to see the tags
+  $ git log [last release tag]..HEAD &gt; /tmp/log
+  #   get the commit log since the last release
+  $ utils/makeChangeLog /tmp/log &gt; /tmp/change.log
+  #   reformat the commit log
+</programlisting>
+       <para>
+        Edit <filename>/tmp/change.log</filename> to remove trivial
+        changes and group the changes under general headings like:
+       </para>
+       <programlisting>
+- Bug fixes:
+- Action file improvements:
+- Filter file improvements:
+- General improvements:
+- Documentation improvements:
+- Build system improvements:
+- Code cleanups:
+- Privoxy-Log-Parser:
+- Privoxy-Regression-Test:
+</programlisting>
+       <para>
+        Add the contents of <filename>/tmp/change.log</filename> to the
+        start of <filename>ChangeLog</filename> and re-create
+        <filename>doc/source/changelog.sgml</filename>:
+       </para>
+       <programlisting>
+  $ utils/changelog2doc.pl /tmp/change.log &gt;| doc/source/changelog.sgml
+</programlisting>
+      </listitem>
+      <listitem>
+       <para>
+        All developers should look at the <filename>ChangeLog</filename> and
+        make sure noteworthy changes are referenced.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        All documentation should be rebuilt:
+       <programlisting>
+  $ make dok
+  $ make dok-tidy
+  $ make man
+  $ make config-file
+</programlisting>
         Finished docs should be then be committed to Git (for those
         without the ability to build these). Some docs may require
         rather obscure processing tools. <filename>config</filename>,
@@ -2201,6 +2249,11 @@ for-privoxy-version=3.0.11
         in this manual for details.
        </para>
       </listitem>
+      <listitem>
+       <para>
+        <emphasis>Commit all files that were changed in the above steps!</emphasis>
+       </para>
+      </listitem>
       <listitem>
        <para>
          The <citetitle>User Manual</citetitle> is also used for context
@@ -2215,17 +2268,6 @@ for-privoxy-version=3.0.11
          target for this at this time!!! It needs to be done manually.
        </para>
       </listitem>
-      <listitem>
-       <para>
-        All developers should look at the <filename>ChangeLog</filename> and
-        make sure noteworthy changes are referenced.
-       </para>
-     </listitem>
-      <listitem>
-       <para>
-        <emphasis>Commit all files that were changed in the above steps!</emphasis>
-       </para>
-      </listitem>
       <listitem>
        <para>
         Tag all files in Git with the version number with
@@ -2233,13 +2275,6 @@ for-privoxy-version=3.0.11
         Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
        </para>
       </listitem>
-     <listitem>
-       <para>
-        If the release was in a development branch, increase the point version
-        from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
-        commit your change.
-       </para>
-      </listitem>
      <listitem>
        <para>
         On the webserver, copy the user manual to a new top-level directory