editor-manual/chapter04/updatechangelog.xml

   1 <sect1 id="ch04-updatechangelog">
   2 <title>Update chapter01/changelog.xml</title>
   3 <?dbhtml filename="updatechangelog.html" dir="chapter04"?>
   4
   5 <para>Changelog updates should <emphasis>always</emphasis> be provided
   6 with the exception of small typo fixes. You don't need to add "fixed
   7 small typo in XXX" to the changelog otherwise it'd grow like topsy.</para>
   8
   9 <para>Changelog updates need to be in the following format:
  10 <screen>&lt;listitem&gt;&lt;para&gt;Month Day, Year [username]: Chapter -
  11 Section: What you changed.&lt;/para&gt;&lt;/listitem&gt;</screen></para>
  12
  13 <para>Example:
  14 <screen>&lt;listitem&gt;&lt;para&gt;May 27th, 2002 [gerard]: Chapter 06 -
  15 Ncurses: upgraded to ncurses-5.2-2.patch which is smaller than the previous
  16 one.&lt;/para&gt;&lt;/listitem&gt;</screen></para>
  17
  18 <para>Changelog entries are always on top of the previously added changelog
  19 entry.
  20 </para>
  21
  22 </sect1>