From cf666d95fbafd89154c7e871780735aef890b088 Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Thu, 6 Jun 2024 18:47:19 +0200 Subject: [PATCH] docs(spdx-utils): Duplicate mapping docs into the YML files for visibility Signed-off-by: Sebastian Schuberth --- utils/spdx/src/main/resources/declared-license-mapping.yml | 4 ++++ utils/spdx/src/main/resources/simple-license-mapping.yml | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/utils/spdx/src/main/resources/declared-license-mapping.yml b/utils/spdx/src/main/resources/declared-license-mapping.yml index 352bc05755939..c62bf57579653 100644 --- a/utils/spdx/src/main/resources/declared-license-mapping.yml +++ b/utils/spdx/src/main/resources/declared-license-mapping.yml @@ -15,6 +15,10 @@ # SPDX-License-Identifier: Apache-2.0 # License-Filename: LICENSE +# A mapping from license strings collected from the declared licenses of Open Source packages to SPDX expressions. This +# mapping only contains license strings which can *not* be parsed by [SpdxExpression.parse], for example because the +# license names contain white spaces. See [SpdxSimpleLicenseMapping] for a mapping of varied license names. + # Sort the entries below via IntelliJ's "Edit" -> "Sort Lines". # Map a declared license string to "NONE" in order to discard it. --- diff --git a/utils/spdx/src/main/resources/simple-license-mapping.yml b/utils/spdx/src/main/resources/simple-license-mapping.yml index bac7dfd47e5e2..15bcc1d6a5931 100644 --- a/utils/spdx/src/main/resources/simple-license-mapping.yml +++ b/utils/spdx/src/main/resources/simple-license-mapping.yml @@ -15,6 +15,10 @@ # SPDX-License-Identifier: Apache-2.0 # License-Filename: LICENSE +# A mapping from simple license names to valid SPDX license IDs. This mapping only contains license strings which *can* +# be parsed by [SpdxExpression.parse] but have a corresponding valid SPDX license ID that should be used instead. See +# [SpdxDeclaredLicenseMapping] for a mapping of unparsable license strings. + # Sort the entries below via IntelliJ's "Edit" -> "Sort Lines". ---