From 15e379aaf334e7931710b4208ccedf2f9ee44b0d Mon Sep 17 00:00:00 2001 From: Martin Roth Date: Mon, 28 Dec 2020 15:24:49 -0700 Subject: [PATCH] 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 Change-Id: I8bb415c72cf05b91c84f0a945d7767134a74c44c Reviewed-on: https://review.coreboot.org/c/coreboot/+/48967 Reviewed-by: Patrick Georgi Tested-by: build bot (Jenkins) --- util/lint/lint-stable-025-description-md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100755 util/lint/lint-stable-025-description-md diff --git a/util/lint/lint-stable-025-description-md b/util/lint/lint-stable-025-description-md new file mode 100755 index 000000000000..88c3d76c41f5 --- /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