r7614 - in trunk/editor-manual: . chapter01 chapter04

ken at linuxfromscratch.org ken at linuxfromscratch.org
Mon May 15 09:57:08 PDT 2006


Author: ken
Date: 2006-05-15 10:57:08 -0600 (Mon, 15 May 2006)
New Revision: 7614

Added:
   trunk/editor-manual/chapter04/commenting.xml
Modified:
   trunk/editor-manual/chapter01/changelog.xml
   trunk/editor-manual/chapter04/chapter04.xml
   trunk/editor-manual/general.ent
Log:
Mention the use of FIXME: in comments.

Modified: trunk/editor-manual/chapter01/changelog.xml
===================================================================
--- trunk/editor-manual/chapter01/changelog.xml	2006-05-14 20:29:47 UTC (rev 7613)
+++ trunk/editor-manual/chapter01/changelog.xml	2006-05-15 16:57:08 UTC (rev 7614)
@@ -28,6 +28,11 @@
 
  <listitem><para>Changelog Entries:</para>
   <itemizedlist>
+   <listitem><para>May 15, 2006 [ken]</para>
+     <itemizedlist>
+       <listitem><para>chapter04/commenting.xml: Added, to document the use of FIXME:.</para></listitem>
+     </itemizedlist>
+   </listitem>
    <listitem><para>April 10, 2006 [ken]</para>
      <itemizedlist>
        <listitem><para>chapter02/svnssh.xml: Explain how to check out the whole tree</para></listitem>

Modified: trunk/editor-manual/chapter04/chapter04.xml
===================================================================
--- trunk/editor-manual/chapter04/chapter04.xml	2006-05-14 20:29:47 UTC (rev 7613)
+++ trunk/editor-manual/chapter04/chapter04.xml	2006-05-15 16:57:08 UTC (rev 7614)
@@ -13,6 +13,7 @@
  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="updategeneralent.xml"/>
  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="updatechangelog.xml"/>
  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="checkfiles.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="commenting.xml"/>
  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="commit.xml"/>
  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="trac.xml"/>
 </chapter>

Added: trunk/editor-manual/chapter04/commenting.xml
===================================================================
--- trunk/editor-manual/chapter04/commenting.xml	                        (rev 0)
+++ trunk/editor-manual/chapter04/commenting.xml	2006-05-15 16:57:08 UTC (rev 7614)
@@ -0,0 +1,24 @@
+<?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-commenting">
+<title>Commenting something out</title>
+<?dbhtml filename="commenting.html"?>
+
+<para>Sometimes, a change will make something no longer appropriate, but you
+think that it might be needed in the future.  If you comment it out in the
+normal way, and start the comment with a <literal>FIXME:</literal> marker, that
+will be highlighted whenever the file is edited, at least if you use vim.</para>
+
+<para>If you encounter a <emphasis>FIXME:</emphasis> in a comment, do not
+automatically assume that it can be deleted because the following instructions
+have now been commented out.</para>
+
+<para>Note that there is no example here - the rendering of html strips out
+comments, and an empty box looks silly.  As always, render your local copy after
+you comment something out, so that you can see the result!</para>
+
+</sect1>

Modified: trunk/editor-manual/general.ent
===================================================================
--- trunk/editor-manual/general.ent	2006-05-14 20:29:47 UTC (rev 7613)
+++ trunk/editor-manual/general.ent	2006-05-15 16:57:08 UTC (rev 7614)
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<!ENTITY version "20060410">
-<!ENTITY releasedate "April 10th, 2006">
+<!ENTITY version "20060515">
+<!ENTITY releasedate "May 15th, 2006">
 
 <!ENTITY lfs-root "http://www.linuxfromscratch.org/">




More information about the lfs-book mailing list