diff options
| author | Luke T. Shumaker <lukeshu@lukeshu.com> | 2025-02-22 00:30:47 -0700 |
|---|---|---|
| committer | Luke T. Shumaker <lukeshu@lukeshu.com> | 2025-02-23 10:55:12 -0700 |
| commit | c2f977be6492fd93b359c97dee9b2968fe56fef6 (patch) | |
| tree | 7ffd6ab41a2ecf7754d3db0eded4c31257613a48 /build-aux | |
| parent | c990e16bb4754e17a4858274ebd59f1e0859b16f (diff) | |
cmd/sbc_harness: Add documentation for rom.bin and flash.bin
Diffstat (limited to 'build-aux')
| -rwxr-xr-x | build-aux/get-dscname | 28 | ||||
| -rwxr-xr-x | build-aux/lint-generic | 2 |
2 files changed, 27 insertions, 3 deletions
diff --git a/build-aux/get-dscname b/build-aux/get-dscname index c8b3681..34a1b08 100755 --- a/build-aux/get-dscname +++ b/build-aux/get-dscname @@ -1,4 +1,4 @@ -#!/bin/sh +#!/usr/bin/env bash # build-aux/get-dscname - Get a file's self-described filename # # Copyright (C) 2024-2025 Luke T. Shumaker <lukeshu@lukeshu.com> @@ -9,4 +9,28 @@ if [ $# -ne 1 ]; then exit 2 fi -sed -n '1,3{ /^\#!/d; /^<!--$/d; /-\*- .* -\*-/d; s,[/*\# ]*,,; s/ - .*//;p; q; }' -- "$1" +if [[ $1 == */Documentation/* ]] && [[ "$(sed 1q -- "$1")" == 'NAME' ]]; then + sed -n ' + 2{ + s,[/.],_,g; + s,^\s*_,Documentation/,; + s,$,.txt,; + + p; + q; + } + ' -- "$1" +else + sed -n ' + 1,3{ + /^\#!/d; + /^<!--$/d; + /-\*- .* -\*-/d; + s,[/*\# ]*,,; + s/ - .*//; + + p; + q; + } + ' -- "$1" +fi diff --git a/build-aux/lint-generic b/build-aux/lint-generic index 92addcd..58a65d2 100755 --- a/build-aux/lint-generic +++ b/build-aux/lint-generic @@ -31,7 +31,7 @@ for filename in "$@"; do if ! grep -E -q 'Copyright \(C\) 202[4-9]((-|, )202[5-9])* Luke T. Shumaker' "$filename"; then err "$filename" 'is missing a copyright statement' fi - if ! grep -q ' SPDX-License-Identifier[:] ' "$filename"; then + if ! grep -q '\sSPDX-License-Identifier[:] ' "$filename"; then err "$filename" 'is missing an SPDX-License-Identifier' fi |