Changeset ac38e9dc for introduction/welcome/conventions.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:

• introduction/welcome/conventions.xml (modified) (2 diffs)

introduction/welcome/conventions.xml

@@ -112 +112 @@
     installation instructions assume thay are installed.  If a recommended
     package is not desired, the instructions may need to be modified to
-    accomodate the missing package.</para>
+    accommodate the missing package.</para>
     
     <bridgehead renderas="sect3">Optional Dependencies</bridgehead>
@@ -121 +121 @@
     listed without corresponding BLFS instructions.  In this case it is up to
     the user to determine appropriate installation instructions. </para>
+
+  </sect2>
+
+  <sect2>
+  <title>Conventions Used for Kernel Configuration Options</title>
+
+    <para>Some packages have specific needs regarding the kernel configuration.
+    The general layout is the following:</para>
+
+<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>[CONFIG_...] on the right gives the name of the option, so you can
+    easily check whether it is set in your <filename>config</filename> file.
+    The meaning of the various entries is:
+
+    <blockquote>
+    <informaltable frame='none'><tgroup cols="2">
+      <colspec align="left"/><colspec align="left"/><tbody>
+      <row>
+        <entry><emphasis role="bold">Master section</emphasis></entry>
+        <entry>top level menu item</entry>
+      </row>
+      <row>
+        <entry><emphasis role="bold">Subsection</emphasis></entry>
+        <entry>submenu item</entry>
+      </row>
+      <row>
+        <entry>
+          <emphasis role="bold">Required parameter</emphasis></entry>
+        <entry>
+          the option could be either built-in or not selected: it must be
+          selected
+        </entry>
+      </row>
+      <row>
+        <entry>
+          <emphasis role="bold">Required parameter (not as
+          module)</emphasis>
+        </entry>
+        <entry>
+          the option could be either built-in, module, or not selected:
+          it must be selected as built-in
+        </entry>
+      </row>
+      <row>
+        <entry>
+          <emphasis role="bold">Required parameter (could be
+          a module)</emphasis>
+        </entry>
+        <entry>
+          the option could be either built-in, module, or not selected:
+          it must be selected, either as built-in or module
+        </entry>
+      </row>
+      <row>
+        <entry>
+          <emphasis role="bold">Optional parameter</emphasis>
+        </entry>
+        <entry>
+          rarely used: the option could be either built-in, module, or not
+          selected: it may be selected at will
+        </entry>
+      </row>
+      <row>
+        <entry>
+          <emphasis role="bold">Incompatible parameter</emphasis>
+        </entry>
+        <entry>
+          the option could be either built-in or not selected: it must
+          <emphasis>not</emphasis> be selected
+        </entry>
+      </row>
+      <row>
+        <entry>
+          <emphasis role="bold">Incompatible parameter (even as module)</emphasis>
+        </entry>
+        <entry>
+          the option could be either built-in, module, or not selected:
+          it must <emphasis>not</emphasis> be selected
+        </entry>
+      </row>
+    </tbody></tgroup></informaltable>
+    </blockquote>
+    </para>
+
+    <para>Note that, depending on other selections, the angle brackets
+    (&lt;&gt;) may appear as braces ({}), if the option cannot be unselected,
+    or even dashes (-*- or -M-), when the choice is imposed.
+    The help text about the option specifies the other selections on which this
+    option relies, and how those other selections are set.</para>
 
   </sect2>