Changeset 340080b


Ignore:
Timestamp:
12/07/2014 03:55:09 PM (9 years ago)
Author:
Pierre Labastie <pieere@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 7.10, 7.7, 7.8, 7.9, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, basic, bdubbs/svn, elogind, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
Children:
c918f3f
Parents:
ff7487e1
Message:

Add a paragraph on the conventions used for Kernel Configuration sections

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@15157 af4574ff-66df-0310-9fd7-8a98e5e911e0

Location:
introduction/welcome
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • introduction/welcome/changelog.xml

    rff7487e1 r340080b  
    4949      <itemizedlist>
    5050        <listitem>
     51          <para>[pierre] - Add a section about conventions for Kernel
     52          Configuration options in <quote>Conventions Used in this Book</quote>.
     53          </para>
     54        </listitem>
     55        <listitem>
    5156          <para>[fernando] - Update to freetype-2.5.4. Fixes
    5257          <ulink url="&blfs-ticket-root;5921">#5921</ulink>.</para>

  • introduction/welcome/conventions.xml

    rff7487e1 r340080b  
    121121    listed without corresponding BLFS instructions.  In this case it is up to
    122122    the user to determine appropriate installation instructions. </para>
     123
     124  </sect2>
     125
     126  <sect2>
     127  <title>Conventions Used for Kernel Configuration Options</title>
     128
     129    <para>Some packages have specific needs regarding the kernel configuration.
     130    The general layout is the following:</para>
     131
     132<screen><literal>Master section ---&gt;
     133  Subsection ---&gt;
     134    [*]     Required parameter                     [CONFIG_REQU_PAR]
     135    &lt;*&gt;     Required parameter (not as module)     [CONFIG_REQU_PAR_NMOD]
     136    &lt;*/M&gt;   Required parameter (could be a module) [CONFIG_REQU_PAR_MOD]
     137    &lt;*/M/ &gt; Optional parameter                     [CONFIG_OPT_PAR]
     138    [ ] Incompatible parameter                     [CONFIG_INCOMP_PAR]
     139    &lt; &gt; Incompatible parameter (even as module)    [CONFIG_INCOMP_PAR_MOD]</literal></screen>
     140
     141    <para>[CONFIG_...] on the right gives the name of the option, so you can
     142    easily check whether it is set in your <filename>config</filename> file.
     143    The meaning of the various entries is:
     144
     145    <blockquote>
     146    <informaltable frame='none'><tgroup cols="2">
     147      <colspec align="left"/><colspec align="left"/><tbody>
     148      <row>
     149        <entry><emphasis role="bold">Master section</emphasis></entry>
     150        <entry>top level menu item</entry>
     151      </row>
     152      <row>
     153        <entry><emphasis role="bold">Subsection</emphasis></entry>
     154        <entry>submenu item</entry>
     155      </row>
     156      <row>
     157        <entry>
     158          <emphasis role="bold">Required parameter</emphasis></entry>
     159        <entry>
     160          the option could be either built-in or not selected: it must be
     161          selected
     162        </entry>
     163      </row>
     164      <row>
     165        <entry>
     166          <emphasis role="bold">Required parameter (not as
     167          module)</emphasis>
     168        </entry>
     169        <entry>
     170          the option could be either built-in, module, or not selected:
     171          it must be selected as built-in
     172        </entry>
     173      </row>
     174      <row>
     175        <entry>
     176          <emphasis role="bold">Required parameter (could be
     177          a module)</emphasis>
     178        </entry>
     179        <entry>
     180          the option could be either built-in, module, or not selected:
     181          it must be selected, either as built-in or module
     182        </entry>
     183      </row>
     184      <row>
     185        <entry>
     186          <emphasis role="bold">Optional parameter</emphasis>
     187        </entry>
     188        <entry>
     189          rarely used: the option could be either built-in, module, or not
     190          selected: it may be selected at will
     191        </entry>
     192      </row>
     193      <row>
     194        <entry>
     195          <emphasis role="bold">Incompatible parameter</emphasis>
     196        </entry>
     197        <entry>
     198          the option could be either built-in or not selected: it must
     199          <emphasis>not</emphasis> be selected
     200        </entry>
     201      </row>
     202      <row>
     203        <entry>
     204          <emphasis role="bold">Incompatible parameter (even as module)</emphasis>
     205        </entry>
     206        <entry>
     207          the option could be either built-in, module, or not selected:
     208          it must <emphasis>not</emphasis> be selected
     209        </entry>
     210      </row>
     211    </tbody></tgroup></informaltable>
     212    </blockquote>
     213    </para>
     214
     215    <para>Note that, depending on other selections, the angle brackets
     216    (&lt;&gt;) may appear as braces ({}), if the option cannot be unselected,
     217    or even dashes (-*- or -M-), when the choice is imposed.
     218    The help text about the option specifies the other selections on which this
     219    option relies, and how those other selections are set.</para>
    123220
    124221  </sect2>
Note: See TracChangeset for help on using the changeset viewer.