<?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-introduction">
  <title>Introduction</title>
  <?dbhtml filename="introduction.html"?>

  <para>Here is a summary list of things to do before committing changes:</para>

  <itemizedlist>
    <listitem><para>Test the instructions you are adding.</para></listitem>
    <listitem><para>Update <filename>general.ent</filename> with the new date.</para>
    </listitem>
    <listitem><para>Update <filename>chapter01/changelog.xml.</filename></para>
    </listitem>
    <listitem><para>Check that all relevant files have been
      <userinput>svn add</userinput>'d or <userinput>remove</userinput>'d.
      </para>
    </listitem>
    <listitem><para>Check the validity of the XML.</para></listitem>
    <listitem><para>Check that the book renders properly.</para></listitem>
    <listitem><para>Commit it.</para></listitem>
    <listitem><para>Update trac to reflect the changes.</para></listitem>
  </itemizedlist>

  <para>You should normally restrict a revision to one set of changes, so if
    you are updating the versions of three packages you will usually do that in
    three separate revisions.  Also, general updates are normally made to the
    trunk and then merged to branches.  Clearly, what forms a "set" is a matter
    for your judgement, but at least consider any likely impact on other
    current branches who may want to merge some or all of your change.
  </para>

  <para>
    The editors of the LFS book prefer that changes to the date in
    general.ent are made as part of a <emphasis>real</emphasis> change, even
    though this adds to what has to be done in a merge.
  </para>
</sect1>
