Changeset 1cf24363 for introduction/welcome

Timestamp:

07/31/2023 01:44:38 PM (11 months ago)

Author:

Xi Ruoyao <xry111@…>

Branches:

12.0, 12.1, ken/TL2024, ken/tuningfonts, lazarus, plabs/newcss, python3.11, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, xry111/llvm18

Children:

cddcdb14

Parents:

0add366

git-author:

Xi Ruoyao <xry111@…> (07/31/2023 12:59:44 PM)

git-committer:

Xi Ruoyao <xry111@…> (07/31/2023 01:44:38 PM)

Message:

introduction: Use new kernel configuration rendering in conventions

Location:

introduction/welcome

Files:

• conventions-kernel.xml (added)
• conventions.xml (modified) (3 diffs)

introduction/welcome/conventions.xml

@@ -136 +136 @@
     The general layout for these looks like this:</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:
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="conventions-kernel.xml"/>
+
+    <para>[...] on the right gives the symbolic name of the option, so you
+    can easily check whether it is set in your <filename>.config</filename>
+    file. Note that the <filename>.config</filename> file contains a
+    <literal>CONFIG_</literal> prefix before all symbolic names.  The
+    meaning of the various entries is:
 
     <blockquote>
@@ -190 +186 @@
       <row>
         <entry>
+          <emphasis role="bold">Required parameter (as
+          a module)</emphasis>
+        </entry>
+        <entry>
+          the option can be built-in, a module, or not selected:
+          it must be selected as a module; selecting it as built-in
+          may cause unwanted effects
+        </entry>
+      </row>
+      <row>
+        <entry>
           <emphasis role="bold">Optional parameter</emphasis>
         </entry>
         <entry>
-          rarely used: the option can be built-in, a module, or not
-          selected: it may be set any way you wish
+          the option can be built-in, a module, or not
+          selected: it may be selected as a module or built-in if you
+          need it for driving the hardware or optional kernel features
+        </entry>
+      </row>
+      <row>
+        <entry>
+          <emphasis role="bold">Optional parameter</emphasis>
+        </entry>
+        <entry>
+          the option can be built-in, a module, or not
+          selected: it may be selected as a module if you need it
+          for driving the hardware or optional kernel features, but
+          selecting it as built-in may cause unwanted effects
         </entry>
       </row>
@@ -224 +243 @@
     The help text describing the option specifies the other selections on which this
     option relies, and how those other selections are set.</para>
+
+    <para>
+      The letter in <emphasis role='blue'>blue</emphasis> is the hotkey
+      for this option.  If you are running
+      <command>make menuconfig</command>, you can press a key to quickly
+      traverse all the options with this key as the hotkey on the screen.
+    </para>
 
     <para>&nbsp;</para> <!-- add extra white space to improve readability -->