diff options
| author | Felix Singer <felixsinger@posteo.net> | 2023-08-25 20:04:21 +0200 |
|---|---|---|
| committer | Felix Singer <service+coreboot-gerrit@felixsinger.de> | 2023-08-27 11:14:02 +0000 |
| commit | 471de17fd59c95f9cac25ecb67bbfc73aa40868a (patch) | |
| tree | bf9f2793b7f9f56512dc394978ba18383d89522a | |
| parent | facdfe46229931cab242bf975894e100ff95c80f (diff) | |
doc,util: Regenerate documentation files
Add new documentation generated by util/util_readme/util_readme.sh.
This also fixes the following Sphinx warning:
util/abuild/index.md: WARNING: document isn't included in any toctree
Change-Id: I26c33af3c5a5853f6bcce23e982a6b192b01f1d7
Signed-off-by: Felix Singer <felixsinger@posteo.net>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/77441
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Nicholas Chin <nic.c3.14@gmail.com>
| -rw-r--r-- | Documentation/util.md | 12 | ||||
| -rw-r--r-- | util/README.md | 10 |
2 files changed, 15 insertions, 7 deletions
diff --git a/Documentation/util.md b/Documentation/util.md index 9823a143ce..a23a965f9c 100644 --- a/Documentation/util.md +++ b/Documentation/util.md @@ -49,8 +49,8 @@ file `Python` * __cbmem__ - CBMEM parser to read e.g. timestamps and console log `C` * __chromeos__ - These scripts can be used to access ChromeOS resources, for example to extract System Agent reference code and other -blobs (e.g. mrc.bin, refcode, VGA option roms) from a ChromeOS -recovery image. `C` +blobs (e.g. mrc.bin, refcode, VGA option roms) from a ChromeOS recovery +image. `C` * __crossgcc__ - A cross toolchain builder for -elf toolchains (ie. no libc support) `Bash` * __docker__ - Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_, @@ -88,7 +88,7 @@ firmware of many HP laptops with 8051-based SMSC KBC1098/KBC1126 embedded controller and insert them to the firmware image. `C` * __kconfig__ - Build system `Make` * __lint__ - Source linter and linting rules `Shell` -* __liveiso__ - A script and NixOS configuration files to create an ISO +* __nixos__ - A script and NixOS configuration files to create an ISO image for testing purposes and for working on firmware. `Bash` * __mainboard__ - mainboard specific scripts * _google_ - Directory for google mainboard specific scripts @@ -138,6 +138,10 @@ for the files modified in a patch or for a file `Perl` license headers `Shell` * _parse-maintainers.pl_ - Script to alphabetize MAINTAINERS file `Perl` + * _rm_unused_code_ - Remove all code not used for a platform +from the local git repository for auditing or release `Bash` + * _show_platforms.sh_ - Makes a list of platforms in the tree. +Does not show variants. `Shell` * _ucode_h_to_bin.sh_ - Microcode conversion tool `Bash` * _update_submodules_ - Check all submodules for updates `Bash` * __showdevicetree__ - Compile and dump the device tree `C` @@ -162,9 +166,9 @@ the documentation `Bash` * __x86__ - Generates 32-bit PAE page tables based on a CSV input file. `Go` * __xcompile__ - Cross compile setup `Bash` - ## In depth documentation +* [abuild](util/abuild/index.md) * [cbfstool](util/cbfstool/index.md) * [ifdtool](util/ifdtool/index.md) * [intelp2m](util/intelp2m/index.md) diff --git a/util/README.md b/util/README.md index 8946bf2dc8..c7e1a74f6e 100644 --- a/util/README.md +++ b/util/README.md @@ -38,8 +38,8 @@ file `Python` * __cbmem__ - CBMEM parser to read e.g. timestamps and console log `C` * __chromeos__ - These scripts can be used to access ChromeOS resources, for example to extract System Agent reference code and other -blobs (e.g. mrc.bin, refcode, VGA option roms) from a ChromeOS -recovery image. `C` +blobs (e.g. mrc.bin, refcode, VGA option roms) from a ChromeOS recovery +image. `C` * __crossgcc__ - A cross toolchain builder for -elf toolchains (ie. no libc support) `Bash` * __docker__ - Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_, @@ -77,7 +77,7 @@ firmware of many HP laptops with 8051-based SMSC KBC1098/KBC1126 embedded controller and insert them to the firmware image. `C` * __kconfig__ - Build system `Make` * __lint__ - Source linter and linting rules `Shell` -* __liveiso__ - A script and NixOS configuration files to create an ISO +* __nixos__ - A script and NixOS configuration files to create an ISO image for testing purposes and for working on firmware. `Bash` * __mainboard__ - mainboard specific scripts * _google_ - Directory for google mainboard specific scripts @@ -127,6 +127,10 @@ for the files modified in a patch or for a file `Perl` license headers `Shell` * _parse-maintainers.pl_ - Script to alphabetize MAINTAINERS file `Perl` + * _rm_unused_code_ - Remove all code not used for a platform +from the local git repository for auditing or release `Bash` + * _show_platforms.sh_ - Makes a list of platforms in the tree. +Does not show variants. `Shell` * _ucode_h_to_bin.sh_ - Microcode conversion tool `Bash` * _update_submodules_ - Check all submodules for updates `Bash` * __showdevicetree__ - Compile and dump the device tree `C` |