sravan/system76-coreboot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: Add util.md summary

Browse Source 
Add short explanation of Utility list

Change-Id: I5fc45ebe29cd42c1aa18c59dabc3ac3db3107bd7
Signed-off-by: Tom Hiller <thrilleratplay@gmail.com>
Reviewed-on: https://review.coreboot.org/27656
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Patrick Rudolph <siro@das-labor.org>
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
This commit is contained in:
Tom Hiller
2018-07-26 21:33:35 -04:00
committed by Philipp Deppenwiese
parent 781693f211
commit 785dee005b
2 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/util.md
View File

@@ -1,4 +1,5 @@
# Utilities # Utilities
_Scripts and programs found in the `./util` directory_
* __abuild__ - coreboot autobuild script builds coreboot images for all * __abuild__ - coreboot autobuild script builds coreboot images for all
available targets. `bash` available targets. `bash`
* __acpi__ - Walk through all ACPI tables with their addresses. `bash` * __acpi__ - Walk through all ACPI tables with their addresses. `bash`

2
util/util_readme/util_readme.sh
View File

@@ -10,11 +10,13 @@ UTIL_README_DIR="$(cd "$(dirname "$0")" || exit; pwd -P)"
UTIL_DIR=$(dirname "$UTIL_README_DIR") UTIL_DIR=$(dirname "$UTIL_README_DIR")
COREBOOT_ROOT_DIR=$(dirname "$UTIL_DIR") COREBOOT_ROOT_DIR=$(dirname "$UTIL_DIR")
DOCMENTATION_DIR="$COREBOOT_ROOT_DIR/Documentation" DOCMENTATION_DIR="$COREBOOT_ROOT_DIR/Documentation"
SUMMARY="_Scripts and programs found in the \`./util\` directory_"
DESCRIPTION_FILES=$(find "$UTIL_DIR" -name "description.md" | sort) DESCRIPTION_FILES=$(find "$UTIL_DIR" -name "description.md" | sort)
echo -n "" > "$UTIL_DIR/README.md" echo -n "" > "$UTIL_DIR/README.md"
echo "# Utilities" > "$DOCMENTATION_DIR/util.md" echo "# Utilities" > "$DOCMENTATION_DIR/util.md"
echo "$SUMMARY" >> "$DOCMENTATION_DIR/util.md"
for DESC_FILE in $DESCRIPTION_FILES; do for DESC_FILE in $DESCRIPTION_FILES; do
UTIL_NAME=$(echo "$DESC_FILE" | rev | cut -d '/' -f2 | rev) UTIL_NAME=$(echo "$DESC_FILE" | rev | cut -d '/' -f2 | rev)