diff mbox series

[1/2] docbook-xml-dtd4: clean up LICENSE situation

Message ID 20250317125159.3675476-1-ross.burton@arm.com
State New
Headers show
Series [1/2] docbook-xml-dtd4: clean up LICENSE situation | expand

Commit Message

Ross Burton March 17, 2025, 12:51 p.m. UTC
Don't use the common 'OASIS' license, as this isn't a SPDX license and
is in fact specifically the DocBook XML v4 license text.

Instead, use NO_GENERIC_LICENSE to ship a custom license file. We still
need to ship a copy of it in-tree because the license code needs a bare
copy of the license text.  Reference the in-tree license text in the
license checksum to show that we've verified they match.

Also, clean up some comments.

Thanks to hongxu.jia@eng.windriver.com for a previous iteration of this.

Signed-off-by: Ross Burton <ross.burton@arm.com>
---
 .../docbook-xml-dtd4/LICENSE-OASIS            |  4 ---
 .../docbook-xml/docbook-xml-dtd4_4.5.bb       | 25 ++++---------------
 2 files changed, 5 insertions(+), 24 deletions(-)

Comments

patchtest@automation.yoctoproject.org March 17, 2025, 1:02 p.m. UTC | #1
Thank you for your submission. Patchtest identified one
or more issues with the patch. Please see the log below for
more information:

---
Testing patch /home/patchtest/share/mboxes/1-2-docbook-xml-dtd4-clean-up-LICENSE-situation.patch

FAIL: test lic files chksum modified not mentioned: LIC_FILES_CHKSUM changed without "License-Update:" tag and description in commit message (test_metadata.TestMetadata.test_lic_files_chksum_modified_not_mentioned)

PASS: pretest src uri left files (test_metadata.TestMetadata.pretest_src_uri_left_files)
PASS: test CVE check ignore (test_metadata.TestMetadata.test_cve_check_ignore)
PASS: test Signed-off-by presence (test_mbox.TestMbox.test_signed_off_by_presence)
PASS: test author valid (test_mbox.TestMbox.test_author_valid)
PASS: test commit message presence (test_mbox.TestMbox.test_commit_message_presence)
PASS: test commit message user tags (test_mbox.TestMbox.test_commit_message_user_tags)
PASS: test max line length (test_metadata.TestMetadata.test_max_line_length)
PASS: test mbox format (test_mbox.TestMbox.test_mbox_format)
PASS: test non-AUH upgrade (test_mbox.TestMbox.test_non_auh_upgrade)
PASS: test shortlog format (test_mbox.TestMbox.test_shortlog_format)
PASS: test shortlog length (test_mbox.TestMbox.test_shortlog_length)
PASS: test src uri left files (test_metadata.TestMetadata.test_src_uri_left_files)
PASS: test target mailing list (test_mbox.TestMbox.test_target_mailing_list)

SKIP: pretest pylint: No python related patches, skipping test (test_python_pylint.PyLint.pretest_pylint)
SKIP: test CVE tag format: No new CVE patches introduced (test_patch.TestPatch.test_cve_tag_format)
SKIP: test Signed-off-by presence: No new CVE patches introduced (test_patch.TestPatch.test_signed_off_by_presence)
SKIP: test Upstream-Status presence: No new CVE patches introduced (test_patch.TestPatch.test_upstream_status_presence_format)
SKIP: test bugzilla entry format: No bug ID found (test_mbox.TestMbox.test_bugzilla_entry_format)
SKIP: test lic files chksum presence: No added recipes, skipping test (test_metadata.TestMetadata.test_lic_files_chksum_presence)
SKIP: test license presence: No added recipes, skipping test (test_metadata.TestMetadata.test_license_presence)
SKIP: test pylint: No python related patches, skipping test (test_python_pylint.PyLint.test_pylint)
SKIP: test series merge on head: Merge test is disabled for now (test_mbox.TestMbox.test_series_merge_on_head)
SKIP: test summary presence: No added recipes, skipping test (test_metadata.TestMetadata.test_summary_presence)

---

Please address the issues identified and
submit a new revision of the patch, or alternatively, reply to this
email with an explanation of why the patch should be accepted. If you
believe these results are due to an error in patchtest, please submit a
bug at https://bugzilla.yoctoproject.org/ (use the 'Patchtest' category
under 'Yocto Project Subprojects'). For more information on specific
failures, see: https://wiki.yoctoproject.org/wiki/Patchtest. Thank
you!
diff mbox series

Patch

diff --git a/meta/recipes-devtools/docbook-xml/docbook-xml-dtd4/LICENSE-OASIS b/meta/recipes-devtools/docbook-xml/docbook-xml-dtd4/LICENSE-OASIS
index 6da7f5b8c74..13f303dc6ae 100644
--- a/meta/recipes-devtools/docbook-xml/docbook-xml-dtd4/LICENSE-OASIS
+++ b/meta/recipes-devtools/docbook-xml/docbook-xml-dtd4/LICENSE-OASIS
@@ -10,7 +10,3 @@  If you modify the DocBook DTD in any way, except for declaring and
 referencing additional sets of general entities and declaring
 additional notations, label your DTD as a variant of DocBook.  See
 the maintenance documentation for more information.
-
-Please direct all questions, bug reports, or suggestions for 
-changes to the docbook@lists.oasis-open.org mailing list. For more
-information, see http://www.oasis-open.org/docbook/.
diff --git a/meta/recipes-devtools/docbook-xml/docbook-xml-dtd4_4.5.bb b/meta/recipes-devtools/docbook-xml/docbook-xml-dtd4_4.5.bb
index 5229a0366c2..58e9b6659e5 100644
--- a/meta/recipes-devtools/docbook-xml/docbook-xml-dtd4_4.5.bb
+++ b/meta/recipes-devtools/docbook-xml/docbook-xml-dtd4_4.5.bb
@@ -3,28 +3,13 @@  DESCRIPTION = "Document type definitions for verification of XML data \
 files against the DocBook rule set."
 HOMEPAGE = "https://docbook.org"
 
-# The upstream sources are not distributed with a license file.
-# LICENSE-OASIS is included as a "patch" to workaround this. When
-# upgrading this recipe, please verify whether this is still needed.
+LICENSE = "DocBook"
+NO_GENERIC_LICENSE[DocBook] = "LICENSE-OASIS"
 
-LICENSE = "OASIS"
-LIC_FILES_CHKSUM = "file://${S}/LICENSE-OASIS;md5=c608985dd5f7f215e669e7639a0b1d2e"
-
-# To support apps with xml schema backward compatibility, we must
-# install a set of schemas. Install the latest based on PV and then
-# name any specific versions as required. TODO: Figure out a mechanism
-# to filter exactly which versions are necessary, if that's even
-# possible.
-#
-# DocBook.org lists available release packages at https://docbook.org/xml/.
-#
-# The release packages relate docbook source at
-# https://github.com/docbook/docbook but building them requires the
-# Gradle build system. In future, it might be safer to use the source
-# tree which would also enable proper SBOM generation through the
-# bitbake build system.
-#
+LIC_FILES_CHKSUM = "file://docbook-4.5/docbookx.dtd;beginline=15;endline=30;md5=ab12da76ad94a41d04e1587693ebd9b6 \
+                    file://LICENSE-OASIS;md5=b9ee6208caa6e66c68dfad6f31d73f92"
 
+# Install the latest 4.5 DTDs, and the previous releases for backward compatibility.
 SRC_URI = "https://docbook.org/xml/4.1.2/docbkx412.zip;name=payload412;subdir=docbook-4.1.2 \
            https://docbook.org/xml/4.2/docbook-xml-4.2.zip;name=payload42;subdir=docbook-4.2 \
            https://docbook.org/xml/4.3/docbook-xml-4.3.zip;name=payload43;subdir=docbook-4.3 \