2019-07-14 02:34:40 +01:00
|
|
|
#!/bin/bash -ex
|
|
|
|
|
chore: make yuzu REUSE compliant
[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 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-15 01:06:02 +01:00
|
|
|
# SPDX-FileCopyrightText: 2019 yuzu Emulator Project
|
|
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
|
2024-01-08 14:15:19 +00:00
|
|
|
shopt -s nullglob globstar
|
|
|
|
|
2024-01-10 16:52:58 +00:00
|
|
|
if git grep -nrI '\s$' src **/*.yml **/*.txt **/*.md Doxyfile .gitignore .gitmodules .ci* dist/*.desktop dist/*.svg dist/*.xml; then
|
2019-07-14 02:34:40 +01:00
|
|
|
echo Trailing whitespace found, aborting
|
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
|
|
|
|
# Default clang-format points to default 3.5 version one
|
2024-01-08 14:15:19 +00:00
|
|
|
CLANG_FORMAT="${CLANG_FORMAT:-clang-format-15}"
|
|
|
|
"$CLANG_FORMAT" --version
|
2019-07-14 02:34:40 +01:00
|
|
|
|
|
|
|
# Turn off tracing for this because it's too verbose
|
|
|
|
set +x
|
|
|
|
|
2024-01-08 14:15:19 +00:00
|
|
|
# Check everything for branch pushes
|
|
|
|
FILES_TO_LINT="$(find src/ -name '*.cpp' -or -name '*.h')"
|
|
|
|
|
|
|
|
for f in $FILES_TO_LINT; do
|
|
|
|
echo "$f"
|
|
|
|
"$CLANG_FORMAT" -i "$f"
|
2019-07-14 02:34:40 +01:00
|
|
|
done
|
|
|
|
|
2024-01-11 23:57:07 +00:00
|
|
|
DIFF=$(git -c core.fileMode=false diff)
|
2019-07-14 02:34:40 +01:00
|
|
|
|
2024-01-08 14:15:19 +00:00
|
|
|
if [ ! -z "$DIFF" ]; then
|
|
|
|
echo "!!! Not compliant to coding style, here is the fix:"
|
|
|
|
echo "$DIFF"
|
2019-07-14 02:34:40 +01:00
|
|
|
exit 1
|
|
|
|
fi
|