editor-manual/chapter04/commit.xml

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