From patchwork Mon Dec 18 21:44:29 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36592 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 4FC6EC46CA2 for ; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web10.3161.1702935907134075747 for ; Mon, 18 Dec 2023 13:45:07 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=QUYKg3Ah; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 6075940005; Mon, 18 Dec 2023 21:45:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935905; 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=3w0FyFnQZJrcecXE3JbqX+SoH5M7BxK1zNxcEy/fOQA=; b=QUYKg3AhoJmNE5FNKMZDjV5U81eXeqschC7voS/8wOkMaiPeXbLAjLCR8piy6IApC8yB8F sWezsjmJDCxmAS29aQjHSRXBXyrZy4F5Gu/jXKk34o3k6Xyx6JYGXCT5W4/Gbj0dB3/2Zu RSnCaPGf5J4eAAyXBWhvPyhQCsNA3V+WSix62pDxWLhABhPkhWW+sIbEcdvUq6pFbbN9d5 /CXrcMIXyRD13+hffASX1LX8sZ8HkmhsaRY4OvwgPJhUhV6cBIjtqB0hlDqAEMuFNtISzb fMylUqdaCfARejdbtQTKjknK8MVUQFbq3zgh0ZCbm70L//2ksp1DP+ElctK+TQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Justin Bronder Subject: [kirkstone][PATCH 05/18] contributor-guide: add License-Update tag Date: Mon, 18 Dec 2023 22:44:29 +0100 Message-Id: <20231218214442.147385-6-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> 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, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4712 From: Michael Opdenacker From: Justin Bronder Porting from the old wiki https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935#Describing_license_changes Signed-off-by: Justin Bronder Reviewed-by: Michael Opdenacker --- .../contributor-guide/recipe-style-guide.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst index a005aa3247..08d8fb4259 100644 --- a/documentation/contributor-guide/recipe-style-guide.rst +++ b/documentation/contributor-guide/recipe-style-guide.rst @@ -250,6 +250,18 @@ Recipes need to define both the :term:`LICENSE` and correct string that you can substitute into the recipe file for a subsequent build. +License Updates +~~~~~~~~~~~~~~~ + +When you change the :term:`LICENSE` or :term:`LIC_FILES_CHKSUM` in the recipe +you need to briefly explain the reason for the change via a ``License-Update:`` +tag. Often it's quite trivial, such as:: + + License-Update: copyright years refreshed + +Less often, the actual licensing terms themselves will have changed. If so, do +try to link to upstream making/justifying that decision. + Tips and Guidelines for Writing Recipes ---------------------------------------