Changeset ac38e9dc for template/template.xml

Timestamp:

08/01/2015 04:26:22 AM (9 years ago)

Author:

Douglas R. Reno <renodr@…>

Branches:

systemd-13485

Children:

ad6910d

Parents:

4a83293

Message:

Import back into SVN from Github

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@16309 af4574ff-66df-0310-9fd7-8a98e5e911e0

File:

• template/template.xml (modified) (5 diffs)

template/template.xml

@@ -5 +5 @@
   %general-entities;
 
-  <!-- Place this in the general.ent file
+  <!-- Place this in the packages.ent file
   <!ENTITY TEMPLATE-version "">
   -->
@@ -97 +97 @@
     <bridgehead renderas="sect4">Required</bridgehead>
     <para role="required">
-      <xref linkend="BLFS DEPENDENCY"/> <!-- notice no period as this is not a sentence
-      If there are more than two, they must be separated by commas with the last
-      member having "and" in front of it. The use of a serial comma is preferred
-      (a comma after the next to last member before the "and"). -->
+      <xref linkend="BLFS_DEPENDENCY"/> <!-- notice no period as this is not
+      a sentence. If there are more than two, they must be separated by commas
+      with the last member having "and" in front of it. The use of a serial
+      comma is preferred (a comma after the next to last member before the
+      "and"). BLFS_DEPENDENCY should be an "id" attribute defined somewhere
+      in the book (usually in a <sect1>). -->
     </para>
 
@@ -106 +108 @@
     <bridgehead renderas="sect4">Recommended</bridgehead>
     <para role="recommended">
-      <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink> and
-      <xref linkend="BLFS DEPENDENCY"/> <!-- notice no period as this is not a sentence-->
+      <xref linkend="BLFS_DEPENDENCY"/> <!-- notice no period as this is not
+      a sentence. See above for the use of "and" and commas. Normally, neither
+      required nor recommended dependencies should be <ulink>. -->
     </para>
 
@@ -113 +116 @@
     <bridgehead renderas="sect4">Optional</bridgehead>
     <para role="optional">
+      <xref linkend="BLFS_DEPENDENCY"/> and
       <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>
-      <!-- notice no period as this is not a sentence-->
+      <!-- notice no period as this is not a sentence. See above for the use
+      of commas and "and". The order should <xref> before <ulink>.-->
     </para>
 
@@ -133 +138 @@
 
 <!-- Spaces are significant in <screen> sections -->
-<screen><literal>Master section:
-  Subsection:
-    Required Option: M or Y
-    Incompatible option: N</literal></screen>
+<screen><literal>Master section ---&gt;
+  Subsection ---&gt;
+    [*]     Required parameter                     [CONFIG_REQU_PAR]
+    &lt;*&gt;     Required parameter (not as module)     [CONFIG_REQU_PAR_NMOD]
+    &lt;*/M&gt;   Required parameter (could be a module) [CONFIG_REQU_PAR_MOD]
+    &lt;*/M/ &gt; Optional parameter                     [CONFIG_OPT_PAR]
+    [ ] Incompatible parameter                     [CONFIG_INCOMP_PAR]
+    &lt; &gt; Incompatible parameter (even as module)    [CONFIG_INCOMP_PAR_MOD]</literal></screen>
 
     <para>
       Select the appropriate sub-options that appear when the above options are
-      selected.
+      selected. As much as possible, the layout should be the same as in
+      kernel menus.
     </para>