<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>

<sect1 id="ch04-updatechangelog">
  <title>Update chapter01/changelog.xml</title>
  <?dbhtml filename="updatechangelog.html"?>

  <para>Changelog updates should <emphasis>always</emphasis> be provided with
    the exception of small typo fixes. You don't need to add "fixed small typo
    in XXX" to the changelog otherwise it'd grow like topsy.
  </para>

  <para>Changelog updates need to be in the following format:
    <screen>&lt;listitem&gt;
  &lt;para&gt;Month Day, Year&lt;/para&gt;
  &lt;itemizedlist&gt;
    &lt;listitem&gt;
      &lt;para&gt;[username] - What you changed.&lt;/para&gt;
    &lt;/listitem&gt;
    &lt;listitem&gt;
      &lt;para&gt;[username] - Previous changelog entry from the same day,
      by you or another editor.&lt;/para&gt;
    &lt;/listitem&gt;
  &lt;itemizedlist&gt;
&lt;/listitem&gt;</screen>
</para>

  <para>Example: <screen>&lt;listitem&gt;
  &lt;para&gt;March 3, 2006&lt;/para&gt;
  &lt;itemizedlist&gt;
    &lt;listitem&gt;
      &lt;para&gt;[gerard] - Remove -D_GNU_SOURCE from chapter 5 - Patch. Thanks
      to Dan Nicholson for the patch.&lt;/para&gt;
    &lt;/listitem&gt;
  &lt;/itemizedlist&gt;
&lt;/listitem&gt;</screen>
  </para>

  <para>Changelog entries are always on top of the previously added changelog
    entry.
  </para>
</sect1>
