Philipp Deppenwiese has submitted this change and it was merged. ( https://review.coreboot.org/27656 )
Change subject: Documentation: Add util.md summary ......................................................................
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 --- M Documentation/util.md M util/util_readme/util_readme.sh 2 files changed, 3 insertions(+), 0 deletions(-)
Approvals: build bot (Jenkins): Verified Paul Menzel: Looks good to me, but someone else must approve Philipp Deppenwiese: Looks good to me, approved Patrick Rudolph: Looks good to me, but someone else must approve
diff --git a/Documentation/util.md b/Documentation/util.md index 9adb908..be7cc99 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 2516614..420ffae 100755 --- a/util/util_readme/util_readme.sh +++ b/util/util_readme/util_readme.sh @@ -10,11 +10,13 @@ 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)