summaryrefslogtreecommitdiffstats
path: root/util/lint
diff options
context:
space:
mode:
authorMartin Roth <martin@coreboot.org>2020-12-28 15:24:49 -0700
committerPatrick Georgi <pgeorgi@google.com>2021-01-28 20:17:15 +0000
commit15e379aaf334e7931710b4208ccedf2f9ee44b0d (patch)
treec8034f892e532e7af92365cd091e04275add6329 /util/lint
parent064b250facfcc71c29be91e56e7ff1c6964fc8b0 (diff)
downloadcoreboot-15e379aaf334e7931710b4208ccedf2f9ee44b0d.tar.gz
coreboot-15e379aaf334e7931710b4208ccedf2f9ee44b0d.tar.bz2
coreboot-15e379aaf334e7931710b4208ccedf2f9ee44b0d.zip
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>
Diffstat (limited to 'util/lint')
-rwxr-xr-xutil/lint/lint-stable-025-description-md16
1 files changed, 16 insertions, 0 deletions
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