mirror of
https://github.com/yuzu-emu/yuzu.git
synced 2024-05-20 04:16:43 +00:00
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
30 lines
1 KiB
Bash
Executable file
30 lines
1 KiB
Bash
Executable file
#!/bin/sh
|
|
|
|
# SPDX-FileCopyrightText: 2015 Citra Emulator Project
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
# Enforce yuzu's whitespace policy
|
|
git config --local core.whitespace tab-in-indent,trailing-space
|
|
|
|
paths_to_check="src/ CMakeLists.txt"
|
|
|
|
# If there are whitespace errors, print the offending file names and fail.
|
|
if ! git diff --cached --check -- $paths_to_check ; then
|
|
cat<<END
|
|
|
|
Error: This commit would contain trailing spaces or tabs, which is against this repo's policy.
|
|
Please correct those issues before committing. (Use 'git diff --check' for more details)
|
|
If you know what you are doing, you can try 'git commit --no-verify' to bypass the check
|
|
END
|
|
exit 1
|
|
fi
|
|
|
|
# Check for tabs, since tab-in-indent catches only those at the beginning of a line
|
|
if git diff --cached -- $paths_to_check | egrep '^\+.* '; then
|
|
cat<<END
|
|
Error: This commit would contain a tab, which is against this repo's policy.
|
|
If you know what you are doing, you can try 'git commit --no-verify' to bypass the check.
|
|
END
|
|
exit 1
|
|
fi
|