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>
This commit is contained in:
committed by
Elyes Haouas
parent
18c79fe67b
commit
46630de4b7
@ -14,7 +14,7 @@ to make sure your patch compiles cleanly for all.
|
||||
Note that abuild is a tool to do a simple build test, and binaries it
|
||||
produces may well not boot if flashed to a system.
|
||||
|
||||
### Basic usage
|
||||
## Basic usage
|
||||
|
||||
abuild needs to be run from the coreboot directory. If you cd into the
|
||||
coreboot/util/abuild directory and try to run it from there, it will
|
||||
@ -30,7 +30,7 @@ example, to build the Lenovo X230 target, run:
|
||||
$ util/abuild/abuild -t lenovo/x230
|
||||
```
|
||||
|
||||
### Where builds and logs are stored
|
||||
## Where builds and logs are stored
|
||||
|
||||
The resulting images and logs are stored in directory coreboot-builds/
|
||||
under your current directory. This can be overridden with --outdir:
|
||||
@ -53,7 +53,7 @@ coreboot-builds/passing_boards and coreboot-builds/failing_boards.
|
||||
**These logs are overwritten with each abuild run.** Save them elsewhere
|
||||
if you feel a need to reference the results later.
|
||||
|
||||
### Payloads
|
||||
## Payloads
|
||||
|
||||
You can also specify a payload directory with -p:
|
||||
|
||||
@ -81,7 +81,7 @@ You can also tell abuild not to use a payload:
|
||||
util/abuild/abuild -t lenovo/x230 -p none
|
||||
```
|
||||
|
||||
### Build non-default configurations
|
||||
## Build non-default configurations
|
||||
|
||||
Sometimes you do need to build test a custom, non-default configuration.
|
||||
This can be accomplished by placing a config file in configs/.
|
||||
@ -142,7 +142,7 @@ a file named `myconfig` with this line:
|
||||
and run `abuild -K myconfig` to build everything with a silent postcar
|
||||
stage.
|
||||
|
||||
### Selectively build certain targets only (also config file naming caveats)
|
||||
## Selectively build certain targets only (also config file naming caveats)
|
||||
|
||||
The P8Z77-M PRO example above would fail for P8Z77-M, because the
|
||||
config file name is ambiguous. `abuild` would pick up this config when
|
||||
@ -166,7 +166,7 @@ util/abuild/abuild --skip_unset USE_NATIVE_RAMINIT
|
||||
This example skips building configs not using (Sandy/Ivy Bridge) native
|
||||
RAM init.
|
||||
|
||||
### Additional Examples
|
||||
## Additional Examples
|
||||
|
||||
Many boards have multiple variants. You can build for a specific
|
||||
variant of a board:
|
||||
@ -203,7 +203,7 @@ Of course, the real power of abuild is in testing multiple boards.
|
||||
util/abuild/abuild -B -y -c 8 -p none
|
||||
```
|
||||
|
||||
### Full options list
|
||||
## Full options list
|
||||
|
||||
```text
|
||||
coreboot autobuild v0.11.01 (Feb 3, 2023)
|
||||
|
@ -11,7 +11,7 @@ make
|
||||
./intelp2m -file /path/to/inteltool.log
|
||||
```
|
||||
|
||||
### Platforms
|
||||
## Platforms
|
||||
|
||||
It is possible to use templates for parsing inteltool.log files.
|
||||
To specify such a pattern, use the option `-t <template number>`.
|
||||
@ -51,13 +51,13 @@ platform type is set using the -p option (Sunrise by default):
|
||||
./intelp2m -p <platform> -file path/to/inteltool.log
|
||||
```
|
||||
|
||||
### Packages
|
||||
## Packages
|
||||
|
||||
![][pckgs]
|
||||
|
||||
[pckgs]: gopackages.png
|
||||
|
||||
### Bit fields in macros
|
||||
## Bit fields in macros
|
||||
|
||||
Use the `-fld=cb` option to only generate a sequence of bit fields in
|
||||
a new macro:
|
||||
@ -71,7 +71,7 @@ _PAD_CFG_STRUCT(GPIO_37, PAD_FUNC(NF1) | PAD_TRIG(OFF) | PAD_TRIG(OFF), \
|
||||
PAD_PULL(DN_20K)), /* LPSS_UART0_TXD */
|
||||
```
|
||||
|
||||
### Raw DW0, DW1 register value
|
||||
## Raw DW0, DW1 register value
|
||||
|
||||
To generate the gpio.c with raw PAD_CFG_DW0 and PAD_CFG_DW1 register
|
||||
values you need to use the -fld=raw option:
|
||||
@ -96,7 +96,7 @@ _PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000),
|
||||
_PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000),
|
||||
```
|
||||
|
||||
### Macro Check
|
||||
## Macro Check
|
||||
|
||||
After generating the macro, the utility checks all used
|
||||
fields of the configuration registers. If some field has been
|
||||
@ -115,7 +115,7 @@ PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_38, UP_20K, DEEP, NF1, HIZCRx1, DISPUPD),
|
||||
PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD),
|
||||
```
|
||||
|
||||
### Information level
|
||||
## Information level
|
||||
|
||||
The utility can generate additional information about the bit
|
||||
fields of the DW0 and DW1 configuration registers. Using the
|
||||
@ -158,7 +158,7 @@ PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, \
|
||||
DISPUPD),
|
||||
```
|
||||
|
||||
### Ignoring Fields
|
||||
## Ignoring Fields
|
||||
|
||||
Utilities can generate the _PAD_CFG_STRUCT macro and exclude fields
|
||||
from it that are not in the corresponding PAD_CFG_*() macro:
|
||||
@ -177,7 +177,7 @@ _PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP), \
|
||||
PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)),
|
||||
```
|
||||
|
||||
### FSP-style macro
|
||||
## FSP-style macro
|
||||
|
||||
The utility allows one to generate macros that include fsp/edk2-platform
|
||||
style bitfields:
|
||||
@ -205,6 +205,6 @@ style bitfields:
|
||||
GpioPadConfigLock },
|
||||
```
|
||||
|
||||
### Supported Chipsets
|
||||
## Supported Chipsets
|
||||
|
||||
Sunrise PCH, Lewisburg PCH, Apollo Lake SoC, CannonLake-LP SoCs
|
||||
|
Reference in New Issue
Block a user