From patchwork Mon Sep 11 17:11:30 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 30299 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id D3080EE7FF4 for ; Mon, 11 Sep 2023 17:12:16 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by mx.groups.io with SMTP id smtpd.web10.2825.1694452329687267600 for ; Mon, 11 Sep 2023 10:12:10 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=noFcqJyD; spf=pass (domain: bootlin.com, ip: 217.70.183.195, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id B61C860007; Mon, 11 Sep 2023 17:11:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1694452327; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=VBnDgrE1otiIT7S5q2eokbCTIZ2eyqZU0ib4h3VktCU=; b=noFcqJyDk5+vCGZt7mDn2fmLvTuupEbwSinF1NOmH+lMTX032K/Jdk2x12hUc2vsVRrUUf 7yM7dmXZN3F9KBAnMxIC7w6aDCu/yRNeuT8bcLwSGzwCdt7groLEXZctTnITF5mP8CnKiZ 8Paj5mLeyad09eQvmF921ibnB5MrNb+wy9p1Jus7OL1nkRyqpMe+ykzk783rt+SbHQAXGQ 58J6jFkyAukpNfDcXpF08STu1qEzyw/vmTL3gGXQbyvi0udNVGBfLEDU0aJAkA0TLZiNr4 DfEmXzm21JdsLWLt3Leubds1SOmKal+0PcTPhllAWukkJFvJ81dxBv7Ar/rWdg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Ross Burton , Quentin Schulz Subject: [PATCH v2] manuals: document LICENSE_FLAGS_DETAILS Date: Mon, 11 Sep 2023 19:11:30 +0200 Message-Id: <20230911171130.388684-1-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <1782FABC3543C2E1.16681@lists.yoctoproject.org> References: <1782FABC3543C2E1.16681@lists.yoctoproject.org> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@bootlin.com List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 11 Sep 2023 17:12:16 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4209 From: Michael Opdenacker From: Ross Burton Signed-off-by: Ross Burton Signed-off-by: Michael Opdenacker CC: Quentin Schulz --- Changes in V2: - Remove the "\n" character at the begining of the string No longer needed thanks to https://git.openembedded.org/openembedded-core/commit/?id=5e027da9265e58df016fc3ebe45e4400f0e5c7a7 --- documentation/dev-manual/licenses.rst | 7 +++++++ .../migration-guides/release-notes-4.3.rst | 5 ++++- documentation/ref-manual/variables.rst | 17 +++++++++++++++++ 3 files changed, 28 insertions(+), 1 deletion(-) diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst index 9629dc5329..e3f0aa9dc1 100644 --- a/documentation/dev-manual/licenses.rst +++ b/documentation/dev-manual/licenses.rst @@ -123,6 +123,13 @@ name and version (after variable expansion):: LICENSE_FLAGS = "license_${PN}_${PV}" +It is possible to give more details about a specific license +using flags on the :term:`LICENSE_FLAGS_DETAILS` variable:: + + LICENSE_FLAGS_DETAILS[my-eula-license] = "For further details, see https://example.com/eula." + +If set, this will be displayed to the user if the license hasn't been accepted. + In order for a component restricted by a :term:`LICENSE_FLAGS` definition to be enabled and included in an image, it needs to have a matching entry in the global diff --git a/documentation/migration-guides/release-notes-4.3.rst b/documentation/migration-guides/release-notes-4.3.rst index c19cf6e4f9..87cd622743 100644 --- a/documentation/migration-guides/release-notes-4.3.rst +++ b/documentation/migration-guides/release-notes-4.3.rst @@ -10,6 +10,8 @@ New Features / Enhancements in 4.3 - New variables: + - :term:`FILE_LAYERNAME`: bitbake now sets this to the name of the layer containing the recipe + - :term:`FIT_ADDRESS_CELLS` and :term:`UBOOT_FIT_ADDRESS_CELLS`. See details below. @@ -17,7 +19,8 @@ New Features / Enhancements in 4.3 - :term:`KERNEL_DTBVENDORED`: whether to keep vendor subdirectories. - - :term:`FILE_LAYERNAME`: bitbake now sets this to the name of the layer containing the recipe + - :term:`LICENSE_FLAGS_DETAILS`: add extra details about a recipe license + in case it is not allowed by :term:`LICENSE_FLAGS_ACCEPTED`. - Layername functionality available through overrides diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 7a71abc0ae..11523bb9e7 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -4968,6 +4968,23 @@ system and gives an overview of their function and contents. ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" section in the Yocto Project Development Tasks Manual. + :term:`LICENSE_FLAGS_DETAILS` + Adds details about a flag in :term:`LICENSE_FLAGS`. This way, + if such a flag is not accepted through :term:`LICENSE_FLAGS_ACCEPTED`, + the error message will be more informative, containing the specified + extra details. + + For example, a recipe with an EULA may set:: + + LICENSE_FLAGS = "FooBar-EULA" + LICENSE_FLAGS_DETAILS[FooBar-EULA] = "For further details, see https://example.com/eula." + + If ``Foobar-EULA`` isn't in :term:`LICENSE_FLAGS_ACCEPTED`, the + error message is more useful:: + + Has a restricted license 'FooBar-EULA' which is not listed in your LICENSE_FLAGS_ACCEPTED. + For further details, see https://example.com/eula. + :term:`LICENSE_PATH` Path to additional licenses used during the build. By default, the OpenEmbedded build system uses :term:`COMMON_LICENSE_DIR` to define the