e348eba641
In preparation to update to SPDX license headers, add identifiers for the licenses seen in the coreboot project and create a command line parameter allowing only SPDX license identifiers to be detected. Here are example locations of these licenses: Apache-2.0 - src/soc/sifive BSD-3-Clause - Throughout coreboot & libpayload source GPL-2.0-only - Throughout coreboot source GPL-2.0-or-later - Throughout coreboot source GPL-3.0-only - util/amdtools GPL-3.0-or-later - src/lib/[gcov/libgcov/gnat] ISC - src/lib/ubsan.c, soc/qualcomm/ipq806x/include/soc/gsbi.h, others MIT - soc/nvidia/tegra210/mipi_dsi.c, files in mainboard/cavium/ X11 - include/device/drm_dp_helper.h, drivers/aspeed/common/ast_tables.h Signed-off-by: Martin Roth <martin@coreboot.org> Change-Id: I07a7ca408ac8563e03e189d05ef7729dfb6fc24e Reviewed-on: https://review.coreboot.org/c/coreboot/+/36175 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com> Reviewed-by: Werner Zeh <werner.zeh@siemens.com>
136 lines
3.8 KiB
Bash
Executable file
136 lines
3.8 KiB
Bash
Executable file
#!/bin/sh
|
|
# This file is part of the coreboot project.
|
|
#
|
|
# Copyright (C) 2010 coresystems GmbH
|
|
# Copyright (C) 2016 Google Inc.
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; version 2 of the License.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
#
|
|
# DESCR: Check that files in have valid license headers
|
|
# $1 is an optional command line parameter containing directories to check
|
|
|
|
# regex list of files and directories to exclude from the search
|
|
HEADER_EXCLUDED="\
|
|
^src/lib/gnat/|\
|
|
^src/vendorcode/|\
|
|
^util/amdtools/example_input/|\
|
|
^util/cbfstool/lzma/|\
|
|
^util/kconfig/|\
|
|
^util/romcc/tests|\
|
|
^util/romcc/results|\
|
|
Kconfig|\
|
|
\<COPYING\>|\
|
|
\<LICENSE\>|\
|
|
\<README\>|\
|
|
Changelog|\
|
|
TODO|\
|
|
EXAMPLE|\
|
|
NEWS|\
|
|
ChangeLog|\
|
|
Dockerfile|\
|
|
\.in$|\
|
|
\.[18]$|\
|
|
\.md$|\
|
|
\.wiki$|\
|
|
\.xxdump$|\
|
|
\.spec$|\
|
|
\.txt$|\
|
|
\.jpg$|\
|
|
\.cksum$|\
|
|
\.bin$|\
|
|
\.vbt$|\
|
|
\.hex$|\
|
|
\.patch$|\
|
|
_shipped$|\
|
|
/microcode-[^/]*.h$|\
|
|
/sdram-.*\.inc$|\
|
|
Makefile\.inc|\
|
|
\.fmd|\
|
|
\.cb|\
|
|
\.cfg$|\
|
|
\.spd|\
|
|
config|\
|
|
cmos\.layout|\
|
|
cmos\.default\
|
|
"
|
|
|
|
HEADER_TEXT="license header"
|
|
|
|
#space separated list of directories to test
|
|
if [ "$1" = "" ]; then
|
|
HEADER_DIRS="src util"
|
|
else
|
|
HEADER_DIRS="$1"
|
|
fi
|
|
|
|
if [ "$2" = "SPDX_ONLY" ]; then
|
|
SPDX_ONLY=1
|
|
HEADER_TEXT="SPDX identifier"
|
|
fi
|
|
|
|
LC_ALL=C export LC_ALL
|
|
|
|
#get initial list from git, removing HEADER_EXCLUDED files.
|
|
#make a copy to check for the old style header later.
|
|
headerlist=$(git ls-files $HEADER_DIRS | egrep -v "($HEADER_EXCLUDED)")
|
|
|
|
#update headerlist by removing files that match the license string
|
|
check_for_license() {
|
|
if [ -n "$headerlist" ] && [ -z "$2" ]; then
|
|
headerlist="$(grep -iL "$1" $headerlist 2>/dev/null)"
|
|
elif [ -n "$headerlist" ]; then
|
|
p1list="$(grep -il "$1" $headerlist 2>/dev/null)"
|
|
p2list="$(grep -il "$2" $headerlist 2>/dev/null)"
|
|
|
|
# Make list of files that were in both previous lists
|
|
pbothlist="$(echo $p1list $p2list | tr ' ' "\n" | \
|
|
sort | uniq -d)"
|
|
|
|
# Remove all files that were in both of the previous lists
|
|
# Note that this is unstable if we ever get any filenames
|
|
# with spaces.
|
|
headerlist="$(echo $headerlist $pbothlist | tr ' ' "\n" | \
|
|
sort | uniq -u)"
|
|
fi
|
|
}
|
|
|
|
#search the files for license headers
|
|
check_for_license 'SPDX-License-Identifier: Apache-2.0'
|
|
check_for_license 'SPDX-License-Identifier: BSD-3-Clause'
|
|
check_for_license 'SPDX-License-Identifier: GPL-2.0-only'
|
|
check_for_license 'SPDX-License-Identifier: GPL-2.0-or-later'
|
|
check_for_license 'SPDX-License-Identifier: GPL-3.0-only'
|
|
check_for_license 'SPDX-License-Identifier: GPL-3.0-or-later'
|
|
check_for_license 'SPDX-License-Identifier: ISC'
|
|
check_for_license 'SPDX-License-Identifier: MIT'
|
|
check_for_license 'SPDX-License-Identifier: X11'
|
|
|
|
if [ ! "${SPDX_ONLY}" = "1" ]; then
|
|
check_for_license "under the terms of the GNU General Public License" \
|
|
"WITHOUT ANY WARRANTY"
|
|
check_for_license 'IS PROVIDED .*"AS IS"'
|
|
check_for_license 'IS DISTRIBUTED .*"AS IS"'
|
|
check_for_license "IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE"
|
|
check_for_license '"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES'
|
|
check_for_license 'assumes any liability or responsibility for the use'
|
|
check_for_license 'THE AUTHORS DISCLAIM.*ALL WARRANTIES WITH REGARD TO THIS SOFTWARE'
|
|
check_for_license 'No license required'
|
|
check_for_license 'GNU Lesser General Public'
|
|
fi
|
|
|
|
for file in $headerlist; do
|
|
# Verify the file exists, and has content that requires a header
|
|
# This assumes that a file that has 4 lines or fewer is not notable
|
|
# enough to require a license.
|
|
if [ -f "$file" ] && [ "$(wc -l < "$file")" -gt 4 ]; then
|
|
echo "$file has no recognized ${HEADER_TEXT}."
|
|
fi
|
|
done
|