cdb240f3d4
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to 01cf05bc75
40 lines
1.1 KiB
Bash
40 lines
1.1 KiB
Bash
#!/bin/bash -ex
|
|
|
|
# SPDX-FileCopyrightText: 2019 yuzu Emulator Project
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
if grep -nrI '\s$' src *.yml *.txt *.md Doxyfile .gitignore .gitmodules .ci* dist/*.desktop \
|
|
dist/*.svg dist/*.xml; then
|
|
echo Trailing whitespace found, aborting
|
|
exit 1
|
|
fi
|
|
|
|
# Default clang-format points to default 3.5 version one
|
|
CLANG_FORMAT=clang-format-12
|
|
$CLANG_FORMAT --version
|
|
|
|
if [ "$TRAVIS_EVENT_TYPE" = "pull_request" ]; then
|
|
# Get list of every file modified in this pull request
|
|
files_to_lint="$(git diff --name-only --diff-filter=ACMRTUXB $TRAVIS_COMMIT_RANGE | grep '^src/[^.]*[.]\(cpp\|h\)$' || true)"
|
|
else
|
|
# Check everything for branch pushes
|
|
files_to_lint="$(find src/ -name '*.cpp' -or -name '*.h')"
|
|
fi
|
|
|
|
# Turn off tracing for this because it's too verbose
|
|
set +x
|
|
|
|
for f in $files_to_lint; do
|
|
d=$(diff -u "$f" <($CLANG_FORMAT "$f") || true)
|
|
if ! [ -z "$d" ]; then
|
|
echo "!!! $f not compliant to coding style, here is the fix:"
|
|
echo "$d"
|
|
fail=1
|
|
fi
|
|
done
|
|
|
|
set -x
|
|
|
|
if [ "$fail" = 1 ]; then
|
|
exit 1
|
|
fi
|