summaryrefslogtreecommitdiff
path: root/Documentation/getting_started
diff options
context:
space:
mode:
authorNicholas Chin <nic.c3.14@gmail.com>2024-07-08 20:03:50 -0600
committerElyes Haouas <ehaouas@noos.fr>2024-07-09 21:10:15 +0000
commit46630de4b7a653dbcfd1d10037c73993b258992c (patch)
tree7d7e36d121fdabc9761bfc0d3a48db9d2b23cc97 /Documentation/getting_started
parent18c79fe67ba3e884cebc117b35979dc9c22fac06 (diff)
Documentation: Fix header levels
This fixes the following MyST Parser warnings: - Non-consecutive header level increase - Document headings start at H2, not H1 The header levels (the number of "#" characters before a heading) are intended to form a logical hierarchy of each section and subsection in a document. A subsection typically should have a header level one more than its parent section. Most of these warnings are caused by extra "#" characters, which were simply removed, or sections missing a "#" character to make it fall under its parent section. Notable changes: getting_started/kconfig.md: Changed the header level of the "Keywords" section from 2 to 3 to fall under "Kconfig Language" (level 2), and increased the level of each keyword from 3 to 4 to remain under "Keywords". This also fixes the warnings of "H3 to H5" increases, since the Usage/Example/Notes/Restrictions sections for each keyword had a level of 5. soc/intel/cse_fw_update/cse_fw_update.md: Changed the first line to a top level header acting as the title of the document. Without this soc/intel/index.md displays all the level 2 headers in this document instead of a single link to cse_fw_update.md. Change-Id: Ia1f8b52e39b7b6524bef89a95365541235b5b1b9 Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/83382 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Elyes Haouas <ehaouas@noos.fr>
Diffstat (limited to 'Documentation/getting_started')
-rw-r--r--Documentation/getting_started/kconfig.md54
1 files changed, 27 insertions, 27 deletions
diff --git a/Documentation/getting_started/kconfig.md b/Documentation/getting_started/kconfig.md
index c9e9b3c61a..bff077c47f 100644
--- a/Documentation/getting_started/kconfig.md
+++ b/Documentation/getting_started/kconfig.md
@@ -200,9 +200,9 @@ values to be set based on other values.
visible in the front end.
-## Keywords
+### Keywords
-### bool
+#### bool
The 'bool' keyword assigns a boolean type to a symbol. The allowable values for
a boolean type are 'n' or 'y'. The keyword can be followed by an optional prompt
@@ -238,7 +238,7 @@ bool \[prompt\] \[if &lt;expr&gt;\]
--------------------------------------------------------------------------------
-### choice
+#### choice
This creates a selection list of one or more boolean symbols. For bools, only
one of the symbols can be selected, and one will be be forced to be selected,
@@ -301,7 +301,7 @@ choice \[symbol\]
--------------------------------------------------------------------------------
-### comment
+#### comment
This keyword defines a line of text that is displayed to the user in the
configuration frontend and is additionally written to the output files.
@@ -326,7 +326,7 @@ comment &lt;prompt&gt;
--------------------------------------------------------------------------------
-### config
+#### config
This is the keyword that starts a block defining a Kconfig symbol. The symbol
modifiers follow the 'config' statement.
@@ -363,7 +363,7 @@ config &lt;symbol&gt;
--------------------------------------------------------------------------------
-### default
+#### default
The ‘default’ keyword assigns a value to a symbol in the case where no preset
value exists, i.e. the symbol is not present and assigned in .config. If there
@@ -403,7 +403,7 @@ default &lt;expr&gt; \[if &lt;expr&gt;\]
--------------------------------------------------------------------------------
-### def_bool
+#### def_bool
‘def_bool’ is similar to the 'bool' keyword in that it sets a symbol’s type to
boolean. It lets you set the type and default value at the same time, instead
@@ -437,7 +437,7 @@ def_bool &lt;expr&gt; \[if &lt;expr&gt;\]
--------------------------------------------------------------------------------
-### depends on
+#### depends on
This defines a dependency for a menu entry, including symbols and comments. It
behaves the same as surrounding the menu entry with an if/endif block. If the
@@ -466,28 +466,28 @@ depends on &lt;expr&gt;
--------------------------------------------------------------------------------
-### endchoice
+#### endchoice
This ends a choice block. See the 'choice' keyword for more information and an
example.
--------------------------------------------------------------------------------
-### endif
+#### endif
This ends a block started by the 'if' keyword. See the 'if' keyword for more
information and an example.
--------------------------------------------------------------------------------
-### endmenu
+#### endmenu
This ends a menu block. See the 'menu' keyword for more information and an
example.
--------------------------------------------------------------------------------
-### help
+#### help
The 'help' keyword defines the subsequent block of text as help for a config or
choice block. The help block is started by the 'help' keyword on a line by
@@ -519,7 +519,7 @@ help &lt;help text&gt;
--------------------------------------------------------------------------------
-### hex
+#### hex
This is another symbol type specifier, specifying an unsigned integer value
formatted as hexadecimal.
@@ -555,7 +555,7 @@ hex &lt;expr&gt; \[if &lt;expr&gt;\]
--------------------------------------------------------------------------------
-### if
+#### if
The 'if' keyword is overloaded, used in two different ways. The first definition
enables and disables various other keywords, and follows the other keyword
@@ -596,7 +596,7 @@ endif
--------------------------------------------------------------------------------
-### int
+#### int
A type setting keyword, defines a symbol as an integer, accepting only signed
numeric values. The values can be further restricted with the ‘range’ keyword.
@@ -632,7 +632,7 @@ int &lt;expr&gt; \[if &lt;expr&gt;\]
--------------------------------------------------------------------------------
-### mainmenu
+#### mainmenu
The 'mainmenu' keyword sets the title or title bar of the configuration front
end, depending on how the configuration program decides to use it. It can only
@@ -652,7 +652,7 @@ mainmenu "coreboot configuration"
--------------------------------------------------------------------------------
-### menu
+#### menu
The 'menu' and 'endmenu' keywords tell the configuration front end that the
enclosed statements are part of a group of related pieces.
@@ -699,7 +699,7 @@ endmenu
--------------------------------------------------------------------------------
-### prompt
+#### prompt
The 'prompt' keyword sets the text displayed for a config symbol or choice in
configuration front end.
@@ -752,7 +752,7 @@ prompt &lt;prompt&gt; \[if &lt;expr&gt;\]
prompt "Prompt value 2"
--------------------------------------------------------------------------------
-### range
+#### range
This sets the allowable minimum and maximum entries for hex or int type config
symbols.
@@ -774,7 +774,7 @@ range &lt;symbol&gt; &lt;symbol&gt; \[if &lt;expr&gt;\]
--------------------------------------------------------------------------------
-### select
+#### select
The ‘select’ keyword is used within a bool type config block. In coreboot (and
other projects that don't use modules), the 'select' keyword can force an
@@ -818,7 +818,7 @@ select &lt;symbol&gt; \[if &lt;expr&gt;\]
--------------------------------------------------------------------------------
-### source
+#### source
The 'source' keyword functions much the same as an 'include' statement in c.
This pulls one or more files into Kconfig at the location of the 'source'
@@ -877,7 +877,7 @@ statements that generate a list of all the platform names:
--------------------------------------------------------------------------------
-### string
+#### string
The last of the symbol type assignment keywords. 'string' allows a text value to
be entered.
@@ -923,7 +923,7 @@ keyword later. See the prompt keyword for more notes.
-## Keywords not used in coreboot at the time of writing:
+### Keywords not used in coreboot at the time of writing:
- allnoconfig_y:
- defconfig_list
@@ -948,7 +948,7 @@ statements:
#define SYMBOL NAME XXX
-##### Symbol types:
+#### Symbol types:
- bool, int, and hex types - Every symbol of one of these types created in the
Kconfig tree is defined. It doesn’t matter whether they’re in an if/endif
block, or have a ‘depends on’ statement - they ALL end up being defined in
@@ -1168,19 +1168,19 @@ saved .config file. As always, a 'select' statement overrides any specified
## Kconfig Editor Highlighting
-#### vim:
+### vim:
vim has syntax highlighting for Kconfig built in (or at least as a part of
vim-common), but most editors do not.
-#### ultraedit:
+### ultraedit:
https://github.com/martinlroth/wordfiles/blob/master/kconfig.uew
-#### atom:
+### atom:
https://github.com/martinlroth/language-kconfig