util: Add util_readme script
Bash script to concatenate description.md files into ./util/README.md and Documention/Util.md Change-Id: I015ae6816ea74cacb7f0332fda2c3ebef205c1e2 Signed-off-by: Tom Hiller <thrilleratplay@gmail.com> Reviewed-on: https://review.coreboot.org/27564 Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
This commit is contained in:
Tom Hiller
committed by
Patrick Rudolph
Patrick Rudolph
parent
de690a30a4
commit
ed6d1e6dcc
@@ -20,4 +20,5 @@ Contents:
|
||||
* [Mainboard-specific documentation](mainboard/index.md)
|
||||
* [SuperIO-specific documentation](superio/index.md)
|
||||
* [Vendorcode-specific documentation](vendorcode/index.md)
|
||||
* [Utilities](util.md)
|
||||
* [Release notes for past releases](releases/index.md)
|
||||
|
||||
130
Documentation/util.md
Normal file
130
Documentation/util.md
Normal file
@@ -0,0 +1,130 @@
|
||||
# Utilities
|
||||
* __abuild__ - coreboot autobuild script builds coreboot images for all
|
||||
available targets. `bash`
|
||||
* __acpi__ - Walk through all ACPI tables with their addresses. `bash`
|
||||
* __amdfwtool__ - Create AMD Firmware combination `C`
|
||||
* __amdtools__ - A set of tools to compare extended) K8 memory
|
||||
settings. `Perl`
|
||||
* __archive__ - Concatenate files and create an archive `C`
|
||||
* __mksunxiboot__ - A simple tool to generate bootable image for sunxi
|
||||
platform. `C`
|
||||
* __autoport__ - Automated porting coreboot to Sandy Bridge/Ivy Bridge
|
||||
platforms `Go`
|
||||
* __bimgtool__ - A simple tool which generates and verifies boot images
|
||||
in the BIMG format, used in systems designed by Imagination
|
||||
Technologies, for example the Pistachio SoC. `C`
|
||||
* __bincfg__ - Compiler/Decompiler for data blobs with specs `Lex`
|
||||
`Yacc`
|
||||
* __board_status__ - Tools to collect logs and upload them to the board
|
||||
status repository `Bash` `Go`
|
||||
* __broadcom__ - Generate Broadcom secure boot image. `C`
|
||||
* __cavium__ - Devicetree_convert Tool to convert a DTB to a static C
|
||||
file `Python`
|
||||
* __cbfstool__
|
||||
* _cbfstool_ - For manipulating CBFS file `C`
|
||||
* _fmaptool_ - Converts plaintext fmd files into fmap blobs `C`
|
||||
* _rmodtool_ - Creates rmodules `C`
|
||||
* _ifwitool_ - For manipulating IFWI `C`
|
||||
* __cbmem__ - Cbmem console log reader `C`
|
||||
* __checklist__ - Board implementation checklist generator `Make`
|
||||
* __chromeos__ - These scripts can be used to extract System Agent
|
||||
reference code and other blobs (e.g. mrc.bin, refcode, VGA option roms)
|
||||
from a Chrome OS recovery image. `C`
|
||||
* __crossgcc__ - A cross toolchain builder for -elf toolchains (ie. no
|
||||
libc support)
|
||||
* __docker__ - Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_,
|
||||
_coreboot.org-status_ and _docs.coreboot.org_
|
||||
* __dtd_parser__ - DTD structure parser `Python2`
|
||||
* __ectool__ - Dumps the RAM of a laptop's Embedded/Environmental
|
||||
Controller (EC). `C`
|
||||
* __exynos__ - Computes and fills Exynos ROM checksum (for BL1 or BL2).
|
||||
`Python2`
|
||||
* __futility__ - Firmware utility for signing ChromeOS images `Make`
|
||||
* __fuzz-tests__ - Create test cases that crash the jpeg code. `C`
|
||||
* __genbuild_h__ - Generate build system definitions `Shell`
|
||||
* __genprof__ - Format function tracing logs `Bash` `C`
|
||||
* __gitconfig__ - Initialize git repository submodules install git
|
||||
hooks `Bash`
|
||||
* __ifdfake__ - Create an Intel Firmware Descriptor with just a section
|
||||
layout `C`
|
||||
* __ifdtool__ - Extract and dump Intel Firmware Descriptor information
|
||||
`C`
|
||||
* __intelmetool__ - Dump interesting things about Management Engine
|
||||
even if hidden `C`
|
||||
* __inteltool__ - Provides information about the Intel CPU/chipset
|
||||
hardware configuration (register contents, MSRs, etc). `C`
|
||||
* __intelvbttool__ - Parse VBT from VGA BIOS `C`
|
||||
* __ipqheader__
|
||||
* _createxbl.py_ - Concatentates XBL segments into one ELF
|
||||
image `Python`
|
||||
* _ipqheader.py_ - Returns a packed MBN header image with the
|
||||
specified base and size `Python`
|
||||
* _mbncat.py_ - Generate ipq8064 uber SBL `Python`
|
||||
* *mbn_tools.py* - Contains all MBN Utilities for image
|
||||
generation `Python`
|
||||
* __k8resdump__ - This program will dump the IO/memory/PCI resources
|
||||
from the K8 memory controller `C`
|
||||
* __kbc1126__ - Tools used to dump the two blobs from the factory
|
||||
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`
|
||||
* __marvell__ - Add U-Boot boot loader for Marvell ARMADA38X `C`
|
||||
* __[me_cleaner](https://github.com/corna/me_cleaner)__ - Tool for
|
||||
partial deblobbing of Intel ME/TXE firmware images `Python`
|
||||
* __mma__ - Memory Margin Analysis automation tests `Bash`
|
||||
* __msrtool__ - Dumps chipset-specific MSR registers. `C`
|
||||
* __mtkheader__ - Generate MediaTek bootload header. `Python2`
|
||||
* __nvidia__ - nvidia blob parsers
|
||||
* __nvramtool__ - Reads and writes coreboot parameters and displaying
|
||||
information from the coreboot table in CMOS/NVRAM. `C`
|
||||
* __post__ - Userspace utility that can be used to test POST cards. `C`
|
||||
* __qualcomm__ - CMM script to debug Qualcomm coreboot environments.
|
||||
`CMM`
|
||||
* __release__ - Generate coreboot release `Bash`
|
||||
* __riscv__
|
||||
* _make-spike-elf.sh_ - Converts a flat file into an ELF, that
|
||||
can be passed to SPIKE, the RISC-V reference emulator.`Bash`
|
||||
* _sifive-gpt.py_ - Wraps the bootblock in a GPT partition for
|
||||
SiFive's bootrom. `Python3`
|
||||
* __rockchip__ - Generate Rockchip idblock bootloader. `Python2`
|
||||
* __romcc__ - Compile a C source file generating a binary that does not
|
||||
implicitly use RAM. `C`
|
||||
* __sconfig__ - coreboot device tree compiler `Lex` `Yacc`
|
||||
* __scripts__
|
||||
* _config_ - Manipulate options in a .config file from the
|
||||
command line `Bash`
|
||||
* _cross-repo-cherrypick_ - Pull in patches from another tree
|
||||
from a gerrit repository. `Shell`
|
||||
* _dts-to-fmd.sh_ -Converts a depthcharge fmap.dts into an
|
||||
fmaptool compatible .fmd format `Bash`
|
||||
* _find-unused-kconfig-symbols.sh_ - Points out Kconfig
|
||||
variables that may be unused. There are some false positives, but it
|
||||
serves as a starting point `Shell`
|
||||
* _gerrit-rebase_ - Applies all commits that from-branch has
|
||||
over to-branch, based on a common ancestor and gerrit meta-data `Bash`
|
||||
* _get_maintainer.pl_ - Print selected MAINTAINERS information
|
||||
for the files modified in a patch or for a file `Perl`
|
||||
* _maintainers.go_ - Build subsystem Maintainers `Go`
|
||||
* _no-fsf-addresses.sh_ - Removes various FSF addresses from
|
||||
license headers `Shell`
|
||||
* _parse-maintainers.pl_ - Script to alphabetize MAINTAINERS
|
||||
file `Perl`
|
||||
* _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`
|
||||
* __spkmodem_recv__ - Decode spkmodem signals `C`
|
||||
* __superiotool__ - A user-space utility to detect Super I/O of a
|
||||
mainboard and provide detailed information about the register contents
|
||||
of the Super I/O. `C`
|
||||
* __testing__ - coreboot test targets `Make`
|
||||
* __uio_usbdebug__ - Debug coreboot's usbdebug driver inside a running
|
||||
operating system (only Linux at this time). `C`
|
||||
* __util_readme__ - Creates README.md of description files in `./util`
|
||||
subdirectories `Bash`
|
||||
* __vgabios__ - emulated vga driver for qemu `C`
|
||||
* __viatool__ - Extract certain configuration bits on VIA chipsets and
|
||||
CPUs. `C`
|
||||
* __x86__ - Generates 32-bit PAE page tables based on a CSV input file.
|
||||
`Go`
|
||||
* __xcompile__ - Cross compile setup `Bash`
|
||||
129
util/README.md
Normal file
129
util/README.md
Normal file
@@ -0,0 +1,129 @@
|
||||
* __abuild__ - coreboot autobuild script builds coreboot images for all
|
||||
available targets. `bash`
|
||||
* __acpi__ - Walk through all ACPI tables with their addresses. `bash`
|
||||
* __amdfwtool__ - Create AMD Firmware combination `C`
|
||||
* __amdtools__ - A set of tools to compare extended) K8 memory
|
||||
settings. `Perl`
|
||||
* __archive__ - Concatenate files and create an archive `C`
|
||||
* __mksunxiboot__ - A simple tool to generate bootable image for sunxi
|
||||
platform. `C`
|
||||
* __autoport__ - Automated porting coreboot to Sandy Bridge/Ivy Bridge
|
||||
platforms `Go`
|
||||
* __bimgtool__ - A simple tool which generates and verifies boot images
|
||||
in the BIMG format, used in systems designed by Imagination
|
||||
Technologies, for example the Pistachio SoC. `C`
|
||||
* __bincfg__ - Compiler/Decompiler for data blobs with specs `Lex`
|
||||
`Yacc`
|
||||
* __board_status__ - Tools to collect logs and upload them to the board
|
||||
status repository `Bash` `Go`
|
||||
* __broadcom__ - Generate Broadcom secure boot image. `C`
|
||||
* __cavium__ - Devicetree_convert Tool to convert a DTB to a static C
|
||||
file `Python`
|
||||
* __cbfstool__
|
||||
* _cbfstool_ - For manipulating CBFS file `C`
|
||||
* _fmaptool_ - Converts plaintext fmd files into fmap blobs `C`
|
||||
* _rmodtool_ - Creates rmodules `C`
|
||||
* _ifwitool_ - For manipulating IFWI `C`
|
||||
* __cbmem__ - Cbmem console log reader `C`
|
||||
* __checklist__ - Board implementation checklist generator `Make`
|
||||
* __chromeos__ - These scripts can be used to extract System Agent
|
||||
reference code and other blobs (e.g. mrc.bin, refcode, VGA option roms)
|
||||
from a Chrome OS recovery image. `C`
|
||||
* __crossgcc__ - A cross toolchain builder for -elf toolchains (ie. no
|
||||
libc support)
|
||||
* __docker__ - Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_,
|
||||
_coreboot.org-status_ and _docs.coreboot.org_
|
||||
* __dtd_parser__ - DTD structure parser `Python2`
|
||||
* __ectool__ - Dumps the RAM of a laptop's Embedded/Environmental
|
||||
Controller (EC). `C`
|
||||
* __exynos__ - Computes and fills Exynos ROM checksum (for BL1 or BL2).
|
||||
`Python2`
|
||||
* __futility__ - Firmware utility for signing ChromeOS images `Make`
|
||||
* __fuzz-tests__ - Create test cases that crash the jpeg code. `C`
|
||||
* __genbuild_h__ - Generate build system definitions `Shell`
|
||||
* __genprof__ - Format function tracing logs `Bash` `C`
|
||||
* __gitconfig__ - Initialize git repository submodules install git
|
||||
hooks `Bash`
|
||||
* __ifdfake__ - Create an Intel Firmware Descriptor with just a section
|
||||
layout `C`
|
||||
* __ifdtool__ - Extract and dump Intel Firmware Descriptor information
|
||||
`C`
|
||||
* __intelmetool__ - Dump interesting things about Management Engine
|
||||
even if hidden `C`
|
||||
* __inteltool__ - Provides information about the Intel CPU/chipset
|
||||
hardware configuration (register contents, MSRs, etc). `C`
|
||||
* __intelvbttool__ - Parse VBT from VGA BIOS `C`
|
||||
* __ipqheader__
|
||||
* _createxbl.py_ - Concatentates XBL segments into one ELF
|
||||
image `Python`
|
||||
* _ipqheader.py_ - Returns a packed MBN header image with the
|
||||
specified base and size `Python`
|
||||
* _mbncat.py_ - Generate ipq8064 uber SBL `Python`
|
||||
* *mbn_tools.py* - Contains all MBN Utilities for image
|
||||
generation `Python`
|
||||
* __k8resdump__ - This program will dump the IO/memory/PCI resources
|
||||
from the K8 memory controller `C`
|
||||
* __kbc1126__ - Tools used to dump the two blobs from the factory
|
||||
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`
|
||||
* __marvell__ - Add U-Boot boot loader for Marvell ARMADA38X `C`
|
||||
* __[me_cleaner](https://github.com/corna/me_cleaner)__ - Tool for
|
||||
partial deblobbing of Intel ME/TXE firmware images `Python`
|
||||
* __mma__ - Memory Margin Analysis automation tests `Bash`
|
||||
* __msrtool__ - Dumps chipset-specific MSR registers. `C`
|
||||
* __mtkheader__ - Generate MediaTek bootload header. `Python2`
|
||||
* __nvidia__ - nvidia blob parsers
|
||||
* __nvramtool__ - Reads and writes coreboot parameters and displaying
|
||||
information from the coreboot table in CMOS/NVRAM. `C`
|
||||
* __post__ - Userspace utility that can be used to test POST cards. `C`
|
||||
* __qualcomm__ - CMM script to debug Qualcomm coreboot environments.
|
||||
`CMM`
|
||||
* __release__ - Generate coreboot release `Bash`
|
||||
* __riscv__
|
||||
* _make-spike-elf.sh_ - Converts a flat file into an ELF, that
|
||||
can be passed to SPIKE, the RISC-V reference emulator.`Bash`
|
||||
* _sifive-gpt.py_ - Wraps the bootblock in a GPT partition for
|
||||
SiFive's bootrom. `Python3`
|
||||
* __rockchip__ - Generate Rockchip idblock bootloader. `Python2`
|
||||
* __romcc__ - Compile a C source file generating a binary that does not
|
||||
implicitly use RAM. `C`
|
||||
* __sconfig__ - coreboot device tree compiler `Lex` `Yacc`
|
||||
* __scripts__
|
||||
* _config_ - Manipulate options in a .config file from the
|
||||
command line `Bash`
|
||||
* _cross-repo-cherrypick_ - Pull in patches from another tree
|
||||
from a gerrit repository. `Shell`
|
||||
* _dts-to-fmd.sh_ -Converts a depthcharge fmap.dts into an
|
||||
fmaptool compatible .fmd format `Bash`
|
||||
* _find-unused-kconfig-symbols.sh_ - Points out Kconfig
|
||||
variables that may be unused. There are some false positives, but it
|
||||
serves as a starting point `Shell`
|
||||
* _gerrit-rebase_ - Applies all commits that from-branch has
|
||||
over to-branch, based on a common ancestor and gerrit meta-data `Bash`
|
||||
* _get_maintainer.pl_ - Print selected MAINTAINERS information
|
||||
for the files modified in a patch or for a file `Perl`
|
||||
* _maintainers.go_ - Build subsystem Maintainers `Go`
|
||||
* _no-fsf-addresses.sh_ - Removes various FSF addresses from
|
||||
license headers `Shell`
|
||||
* _parse-maintainers.pl_ - Script to alphabetize MAINTAINERS
|
||||
file `Perl`
|
||||
* _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`
|
||||
* __spkmodem_recv__ - Decode spkmodem signals `C`
|
||||
* __superiotool__ - A user-space utility to detect Super I/O of a
|
||||
mainboard and provide detailed information about the register contents
|
||||
of the Super I/O. `C`
|
||||
* __testing__ - coreboot test targets `Make`
|
||||
* __uio_usbdebug__ - Debug coreboot's usbdebug driver inside a running
|
||||
operating system (only Linux at this time). `C`
|
||||
* __util_readme__ - Creates README.md of description files in `./util`
|
||||
subdirectories `Bash`
|
||||
* __vgabios__ - emulated vga driver for qemu `C`
|
||||
* __viatool__ - Extract certain configuration bits on VIA chipsets and
|
||||
CPUs. `C`
|
||||
* __x86__ - Generates 32-bit PAE page tables based on a CSV input file.
|
||||
`Go`
|
||||
* __xcompile__ - Cross compile setup `Bash`
|
||||
1
util/util_readme/description.md
Normal file
1
util/util_readme/description.md
Normal file
@@ -0,0 +1 @@
|
||||
Creates README.md of description files in `./util` subdirectories `Bash`
|
||||
40
util/util_readme/util_readme.sh
Executable file
40
util/util_readme/util_readme.sh
Executable file
@@ -0,0 +1,40 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Creates `./util/README.md` and `./Documentation/Util.md` of description files
|
||||
# in `./util` subdirectories
|
||||
#
|
||||
# Execute from root of project. Example:
|
||||
# `sh util/util_readme/util_readme.sh`
|
||||
|
||||
UTIL_README_DIR="$(cd "$(dirname "$0")" || exit; pwd -P)"
|
||||
UTIL_DIR=$(dirname "$UTIL_README_DIR")
|
||||
COREBOOT_ROOT_DIR=$(dirname "$UTIL_DIR")
|
||||
DOCMENTATION_DIR="$COREBOOT_ROOT_DIR/Documentation"
|
||||
|
||||
DESCRIPTION_FILES=$(find "$UTIL_DIR" -name "description.md" | sort)
|
||||
|
||||
echo -n "" > "$UTIL_DIR/README.md"
|
||||
echo "# Utilities" > "$DOCMENTATION_DIR/util.md"
|
||||
|
||||
for DESC_FILE in $DESCRIPTION_FILES; do
|
||||
UTIL_NAME=$(echo "$DESC_FILE" | rev | cut -d '/' -f2 | rev)
|
||||
DESC=$(cat "$DESC_FILE")
|
||||
|
||||
if [[ $DESC == "__"${UTIL_NAME}* || $DESC == "__["${UTIL_NAME}* ]]; then
|
||||
DESC="* $DESC"
|
||||
else
|
||||
DESC="* __${UTIL_NAME}__ - $DESC"
|
||||
fi
|
||||
|
||||
# format description to under 72 characters per line and only
|
||||
# breaking on whitespace
|
||||
DESC=$(echo "$DESC" \
|
||||
| tr '\r\n' ' ' \
|
||||
| sed 's/ [*]\+/\n\t\*/g' \
|
||||
| sed 's/ \+/ /g' \
|
||||
| fold -s -w72 \
|
||||
| sed 's/\s*$//')
|
||||
|
||||
echo "$DESC" >> "$UTIL_DIR/README.md"
|
||||
echo "$DESC" >> "$DOCMENTATION_DIR/util.md"
|
||||
done
|
||||
Reference in New Issue
Block a user