Add documentation on checked_by license parameter (#41959)

This patch adds documentation on the checked_by license direcitve
parameter that was added in #40755 but was not documented at that time.
This commit is contained in:
Aiden Grossman 2024-01-11 16:25:11 -08:00 committed by GitHub
parent d98fc65f86
commit 563c481bc0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 3 deletions

View file

@ -6979,3 +6979,18 @@ you probably care most about are:
You may also care about `license exceptions
<https://spdx.org/licenses/exceptions-index.html>`_ that use the ``WITH`` operator,
e.g. ``Apache-2.0 WITH LLVM-exception``.
Many of the licenses that are currently in the spack repositories have been
automatically determined. While this is great for bulk adding license
information and is most likely correct, there are sometimes edge cases that
require manual intervention. To determine which licenses are validated and
which are not, there is the `checked_by` parameter in the license directive:
.. code-block:: python
license("<license>", when="<when>", checked_by="<github username>")
When you have validated a github license, either when doing so explicitly or
as part of packaging a new package, please set the `checked_by` parameter
to your Github username to signal that the license has been manually
verified.

View file

@ -64,8 +64,9 @@ class {class_name}({base_class_name}):
# maintainers("github_user1", "github_user2")
# FIXME: Add the SPDX identifier of the project's license below.
# See https://spdx.org/licenses/ for a list.
license("UNKNOWN")
# See https://spdx.org/licenses/ for a list. Upon manually verifying
# the license, set checked_by to your Github username.
license("UNKNOWN", checked_by="github_user1")
{versions}

View file

@ -27,7 +27,11 @@
[r"TestNamedPackage(Package)", r"def install(self"],
),
(["file://example.tar.gz"], "example", [r"Example(Package)", r"def install(self"]),
(["-n", "test-license"], "test-license", [r'license("UNKNOWN")']),
(
["-n", "test-license"],
"test-license",
[r'license("UNKNOWN", checked_by="github_user1")'],
),
# Template-specific cases
(
["-t", "autoreconf", "/test-autoreconf"],