README: Say that files must be listed in WHENCE, and how to check it

- Say that new files must, not 'should', be listed in WHENCE
- State the expected form of a reference to a separate licence file
- Mention 'make check'

Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
This commit is contained in:
Ben Hutchings 2016-09-18 02:47:17 +01:00
parent c4e9344c06
commit 9c71af939b
1 changed files with 6 additions and 3 deletions

9
README
View File

@ -16,16 +16,19 @@ diff or preferably a git pull request to:
linux-firmware@kernel.org linux-firmware@kernel.org
and also cc: to related mailing lists. and also cc: to related mailing lists.
Your commit should include an update to the WHENCE file clearly If your commit adds new firmware, it must update the WHENCE file to
identifying the license under which the firmware is available, and clearly state the license under which the firmware is available, and
that it is redistributable. Being redistributable includes ensuring that it is redistributable. Being redistributable includes ensuring
the firmware license provided includes an implicit or explicit the firmware license provided includes an implicit or explicit
patent grant to end users to ensure full functionality of device patent grant to end users to ensure full functionality of device
operation with the firmware. If the license is long and involved, it's operation with the firmware. If the license is long and involved, it's
permitted to include it in a separate file and refer to it from the permitted to include it in a separate file and refer to it from the
WHENCE file. WHENCE file ('See LICENSE.foo for details.').
And if it were possible, a changelog of the firmware itself. And if it were possible, a changelog of the firmware itself.
Run 'make check' to check that WHENCE is consistent with the
repository contents.
Ideally, your commit should contain a Signed-Off-By: from someone Ideally, your commit should contain a Signed-Off-By: from someone
authoritative on the licensing of the firmware in question (i.e. from authoritative on the licensing of the firmware in question (i.e. from
within the company that owns the code). within the company that owns the code).