summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hiller <thrilleratplay@gmail.com>2018-07-26 21:33:35 -0400
committerPhilipp Deppenwiese <zaolin.daisuki@gmail.com>2018-07-31 13:10:51 +0000
commit785dee005b8bcf783732b3418e6d3ca609ce9f9c (patch)
treec8eff4bce716413c8ec041c95f8d4d9dd0b89dc6
parent781693f21102a10b2a8faeff2c796c5c5da3ae22 (diff)
downloadcoreboot-785dee005b8bcf783732b3418e6d3ca609ce9f9c.tar.xz
Documentation: Add util.md summary
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>
-rw-r--r--Documentation/util.md1
-rwxr-xr-xutil/util_readme/util_readme.sh2
2 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/util.md b/Documentation/util.md
index 9adb908615..be7cc9906c 100644
--- a/Documentation/util.md
+++ b/Documentation/util.md
@@ -1,4 +1,5 @@
# Utilities
+_Scripts and programs found in the `./util` directory_
* __abuild__ - coreboot autobuild script builds coreboot images for all
available targets. `bash`
* __acpi__ - Walk through all ACPI tables with their addresses. `bash`
diff --git a/util/util_readme/util_readme.sh b/util/util_readme/util_readme.sh
index 251661442c..420ffae698 100755
--- a/util/util_readme/util_readme.sh
+++ b/util/util_readme/util_readme.sh
@@ -10,11 +10,13 @@ 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"
+SUMMARY="_Scripts and programs found in the \`./util\` directory_"
DESCRIPTION_FILES=$(find "$UTIL_DIR" -name "description.md" | sort)
echo -n "" > "$UTIL_DIR/README.md"
echo "# Utilities" > "$DOCMENTATION_DIR/util.md"
+echo "$SUMMARY" >> "$DOCMENTATION_DIR/util.md"
for DESC_FILE in $DESCRIPTION_FILES; do
UTIL_NAME=$(echo "$DESC_FILE" | rev | cut -d '/' -f2 | rev)