Patrick Georgi has submitted this change. ( https://review.coreboot.org/c/coreboot/+/48967 )
Change subject: util/lint: Add test for documentation in util dirs ......................................................................
util/lint: Add test for documentation in util dirs
Make sure that any new directories added to the util directory get documentation added.
Signed-off-by: Martin Roth martin@coreboot.org Change-Id: I8bb415c72cf05b91c84f0a945d7767134a74c44c Reviewed-on: https://review.coreboot.org/c/coreboot/+/48967 Reviewed-by: Patrick Georgi pgeorgi@google.com Tested-by: build bot (Jenkins) no-reply@coreboot.org --- A util/lint/lint-stable-025-description-md 1 file changed, 16 insertions(+), 0 deletions(-)
Approvals: build bot (Jenkins): Verified Patrick Georgi: Looks good to me, approved
diff --git a/util/lint/lint-stable-025-description-md b/util/lint/lint-stable-025-description-md new file mode 100755 index 0000000..88c3d76 --- /dev/null +++ b/util/lint/lint-stable-025-description-md @@ -0,0 +1,16 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0-or-later +# +# DESCR: Check that every utility has a description + +LC_ALL=C export LC_ALL +FAIL=0 + +for i in util/*/; do + if [ ! -r "$i/description.md" ]; then + echo " Failure: util directory $i missing description.md file." + FAIL=1 + fi +done + +exit $FAIL