editor-manual/chapter04/updatechangelog.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   3   <!ENTITY % general-entities SYSTEM "../general.ent">
   4   %general-entities;
   5 ]>
   6
   7 <sect1 id="ch04-updatechangelog">
   8   <title>Update chapter01/changelog.xml</title>
   9   <?dbhtml filename="updatechangelog.html"?>
  10
  11   <para>Changelog updates should <emphasis>always</emphasis> be provided with
  12     the exception of small typo fixes. You don't need to add "fixed small typo
  13     in XXX" to the changelog otherwise it'd grow like topsy.
  14   </para>
  15
  16   <para>Changelog updates need to be in the following format:
  17     <screen>&lt;listitem&gt;
  18   &lt;para&gt;Month Day, Year&lt;/para&gt;
  19   &lt;itemizedlist&gt;
  20     &lt;listitem&gt;
  21       &lt;para&gt;[username] - What you changed.&lt;/para&gt;
  22     &lt;/listitem&gt;
  23     &lt;listitem&gt;
  24       &lt;para&gt;[username] - Previous changelog entry from the same day,
  25       by you or another editor.&lt;/para&gt;
  26     &lt;/listitem&gt;
  27   &lt;itemizedlist&gt;
  28 &lt;/listitem&gt;</screen>
  29 </para>
  30
  31   <para>Example: <screen>&lt;listitem&gt;
  32   &lt;para&gt;March 3, 2006&lt;/para&gt;
  33   &lt;itemizedlist&gt;
  34     &lt;listitem&gt;
  35       &lt;para&gt;[gerard] - Remove -D_GNU_SOURCE from chapter 5 - Patch. Thanks
  36       to Dan Nicholson for the patch.&lt;/para&gt;
  37     &lt;/listitem&gt;
  38   &lt;/itemizedlist&gt;
  39 &lt;/listitem&gt;</screen>
  40   </para>
  41
  42   <para>Changelog entries are always on top of the previously added changelog
  43     entry.
  44   </para>
  45 </sect1>