editor-manual/chapter04/commit.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-commit">
   8 <title>Commit it!</title>
   9 <?dbhtml filename="commit.html"?>
  10
  11 <para>Once you are sure that everything renders and that you know which
  12 files you wish to commit, you're ready. A transaction log of the Subversion commit
  13 will be emailed to the <email>lfs-book@linuxfromscratch.org</email> mailinglist so we
  14 all can see right away what you did. The commit emails contain some basic
  15 info (log, changes to which files) including a <emphasis>diff</emphasis>
  16 format output.</para>
  17
  18 <para>Before you actually commit, spend two seconds thinking about the
  19 log you are going to add. As mentioned in the section on Subversion
  20 commands, comments should <emphasis>always</emphasis> be used when
  21 commiting to the repository. Even if the comment is just 'small typo fix',
  22 that'll do. Other usual comments are 'update to package-x.y.z' or 'fixed
  23 installation instructions of package foo'.</para>
  24
  25 <para>To commit, you use the <userinput>svn commit</userinput> or
  26 <userinput>svn ci</userinput> command. A good example of a commit
  27 command could be:</para>
  28
  29 <screen><userinput>svn ci -m "Fixed typo in chapter 05/bash-inst.xml" \
  30 index.xml chapter01/changelog.xml chapter05/bash-inst.xml</userinput></screen>
  31
  32 <para>If you have only made the changes regarding this package to your tree,
  33 then you can save time by simply running the following from the root of
  34 your local LFS working copy:</para>
  35
  36 <screen><userinput>svn ci -m "Fixed typo in chapter05/bash-inst.xml"</userinput></screen>
  37
  38 <para>The first command is more useful when you've modified files you don't
  39 want to commit at this time, or which require a different log message (for
  40 example a fix to chapter05/binutils-exp.xml).</para>
  41
  42 </sect1>