From patchwork Thu Sep 18 10:24:39 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 70491 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 83038CAC5AE for ; Thu, 18 Sep 2025 10:25:02 +0000 (UTC) Received: from smtp-8faa.mail.infomaniak.ch (smtp-8faa.mail.infomaniak.ch [83.166.143.170]) by mx.groups.io with SMTP id smtpd.web11.10708.1758191092241390515 for ; Thu, 18 Sep 2025 03:24:52 -0700 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 83.166.143.170, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (smtp-3-0001.mail.infomaniak.ch [10.4.36.108]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4cSBb62GWSzKd4; Thu, 18 Sep 2025 12:24:50 +0200 (CEST) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4cSBb569W6zLGV; Thu, 18 Sep 2025 12:24:49 +0200 (CEST) From: Quentin Schulz Date: Thu, 18 Sep 2025 12:24:39 +0200 Subject: [PATCH 1/7] contributor-guide: submit-changes: fix improper bold string MIME-Version: 1.0 Message-Id: <20250918-submit-patches-v1-1-28abd2919df0@cherry.de> References: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> In-Reply-To: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> To: docs@lists.yoctoproject.org Cc: Barne Carstensen , Quentin Schulz , Michael Opdenacker X-Mailer: b4 0.14.2 X-Infomaniak-Routing: alpha 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 ; Thu, 18 Sep 2025 10:25:02 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7545 From: Quentin Schulz I don't know what was the initial intent but this doesn't seem right, so let's remove the bold formatting. Fixes: 4abe87cb20d3 ("contributor-guide: submit-changes: detail commit and patch creation") Cc: Michael Opdenacker Signed-off-by: Quentin Schulz --- documentation/contributor-guide/submit-changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index adb78fa08d8ec783ccdabff41a3ea69f16e7e3a0..e1215a5550f03f780da6478076d665bfe60c0641 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -123,7 +123,7 @@ to add the upgraded version. $ git commit -s file1 file2 dir1 dir2 ... - To include **a**\ ll staged files:: + To include all staged files:: $ git commit -sa From patchwork Thu Sep 18 10:24:40 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 70490 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 64BBFCAC5AD for ; Thu, 18 Sep 2025 10:25:02 +0000 (UTC) Received: from smtp-42ae.mail.infomaniak.ch (smtp-42ae.mail.infomaniak.ch [84.16.66.174]) by mx.groups.io with SMTP id smtpd.web11.10707.1758191092215207463 for ; Thu, 18 Sep 2025 03:24:52 -0700 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 84.16.66.174, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (smtp-3-0001.mail.infomaniak.ch [10.4.36.108]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4cSBb65d2lzJK5; Thu, 18 Sep 2025 12:24:50 +0200 (CEST) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4cSBb626dwzMNt; Thu, 18 Sep 2025 12:24:50 +0200 (CEST) From: Quentin Schulz Date: Thu, 18 Sep 2025 12:24:40 +0200 Subject: [PATCH 2/7] contributor-guide: submit-changes: clarify example with Yocto bug ID MIME-Version: 1.0 Message-Id: <20250918-submit-patches-v1-2-28abd2919df0@cherry.de> References: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> In-Reply-To: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> To: docs@lists.yoctoproject.org Cc: Barne Carstensen , Quentin Schulz X-Mailer: b4 0.14.2 X-Infomaniak-Routing: alpha 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 ; Thu, 18 Sep 2025 10:25:02 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7544 From: Quentin Schulz The example could be understood as the content of the commit message once the editor (git config core.editor) opens, where the first line is the actual commit title and not the commit description. This example would make the Fixes line the commit title, which is not what we want. In short, according to my understanding of git-commit(1): The following is a git commit message: """ git commit title git commit description """ Reported-by: Barne Carstensen Signed-off-by: Quentin Schulz --- documentation/contributor-guide/submit-changes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index e1215a5550f03f780da6478076d665bfe60c0641..35da2dbc70d402eb5b8c6ed450e12f46bb7fcede 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -198,6 +198,8 @@ to add the upgraded version. description. Be sure to use the actual bug-tracking ID from Bugzilla for bug-id:: + single-line summary of change + Fixes [YOCTO #bug-id] detailed description of change From patchwork Thu Sep 18 10:24:41 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 70489 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 73F49CAC5A9 for ; Thu, 18 Sep 2025 10:25:02 +0000 (UTC) Received: from smtp-8fa8.mail.infomaniak.ch (smtp-8fa8.mail.infomaniak.ch [83.166.143.168]) by mx.groups.io with SMTP id smtpd.web11.10709.1758191092569775228 for ; Thu, 18 Sep 2025 03:24:52 -0700 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 83.166.143.168, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (unknown [IPv6:2001:1600:4:17::246c]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4cSBb70ykxzLS5; Thu, 18 Sep 2025 12:24:51 +0200 (CEST) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4cSBb658FJzMFX; Thu, 18 Sep 2025 12:24:50 +0200 (CEST) From: Quentin Schulz Date: Thu, 18 Sep 2025 12:24:41 +0200 Subject: [PATCH 3/7] contributor-guide: submit-changes: align CC tag description MIME-Version: 1.0 Message-Id: <20250918-submit-patches-v1-3-28abd2919df0@cherry.de> References: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> In-Reply-To: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> To: docs@lists.yoctoproject.org Cc: Barne Carstensen , Quentin Schulz X-Mailer: b4 0.14.2 X-Infomaniak-Routing: alpha 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 ; Thu, 18 Sep 2025 10:25:02 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7546 From: Quentin Schulz The other tag descriptions have the double colon outside of the highlight, and start the sentence with a lowercase word, so let's align the CC tag with those. Signed-off-by: Quentin Schulz --- documentation/contributor-guide/submit-changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 35da2dbc70d402eb5b8c6ed450e12f46bb7fcede..2c450625c6d6009802c814db9d523a0343ee6e73 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -223,7 +223,7 @@ to add the upgraded version. or are submitting an unmodified patch again as part of a new iteration of your patch series. - - ``CC:`` Name and email of people you want to send a copy + - ``CC``: name and email of people you want to send a copy of your changes to. This field will be used by ``git send-email``. See `more guidance about using such tags From patchwork Thu Sep 18 10:24:42 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 70488 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 5EFD9CAC5AA for ; Thu, 18 Sep 2025 10:25:02 +0000 (UTC) Received: from smtp-42a8.mail.infomaniak.ch (smtp-42a8.mail.infomaniak.ch [84.16.66.168]) by mx.groups.io with SMTP id smtpd.web10.10436.1758191092918351805 for ; Thu, 18 Sep 2025 03:24:53 -0700 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 84.16.66.168, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (unknown [IPv6:2001:1600:4:17::246c]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4cSBb73f9gzLYC; Thu, 18 Sep 2025 12:24:51 +0200 (CEST) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4cSBb70sSyzK8n; Thu, 18 Sep 2025 12:24:51 +0200 (CEST) From: Quentin Schulz Date: Thu, 18 Sep 2025 12:24:42 +0200 Subject: [PATCH 4/7] contributor-guide: submit-changes: make the Cc tag follow kernel guidelines MIME-Version: 1.0 Message-Id: <20250918-submit-patches-v1-4-28abd2919df0@cherry.de> References: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> In-Reply-To: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> To: docs@lists.yoctoproject.org Cc: Barne Carstensen , Quentin Schulz X-Mailer: b4 0.14.2 X-Infomaniak-Routing: alpha 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 ; Thu, 18 Sep 2025 10:25:02 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7547 From: Quentin Schulz The kernel docs specifies[1] a Cc: tag and not CC: tag, so let's align with that. [1] https://www.kernel.org/doc/html/latest/process/submitting-patches.html#when-to-use-acked-by-cc-and-co-developed-by Signed-off-by: Quentin Schulz --- documentation/contributor-guide/submit-changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 2c450625c6d6009802c814db9d523a0343ee6e73..1de4b6c0ed838d1c4c225df06763f672ff7c27f1 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -223,7 +223,7 @@ to add the upgraded version. or are submitting an unmodified patch again as part of a new iteration of your patch series. - - ``CC``: name and email of people you want to send a copy + - ``Cc``: name and email of people you want to send a copy of your changes to. This field will be used by ``git send-email``. See `more guidance about using such tags From patchwork Thu Sep 18 10:24:43 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 70487 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 5FB2DCAC5AC for ; Thu, 18 Sep 2025 10:25:02 +0000 (UTC) Received: from smtp-190e.mail.infomaniak.ch (smtp-190e.mail.infomaniak.ch [185.125.25.14]) by mx.groups.io with SMTP id smtpd.web10.10437.1758191093666428224 for ; Thu, 18 Sep 2025 03:24:54 -0700 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 185.125.25.14, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (smtp-3-0001.mail.infomaniak.ch [10.4.36.108]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4cSBb818ZNzJYW; Thu, 18 Sep 2025 12:24:52 +0200 (CEST) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4cSBb73X7czJq5; Thu, 18 Sep 2025 12:24:51 +0200 (CEST) From: Quentin Schulz Date: Thu, 18 Sep 2025 12:24:43 +0200 Subject: [PATCH 5/7] contributor-guide: submit-changes: reword commit message instructions MIME-Version: 1.0 Message-Id: <20250918-submit-patches-v1-5-28abd2919df0@cherry.de> References: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> In-Reply-To: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> To: docs@lists.yoctoproject.org Cc: Barne Carstensen , Quentin Schulz X-Mailer: b4 0.14.2 X-Infomaniak-Routing: alpha 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 ; Thu, 18 Sep 2025 10:25:02 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7548 From: Quentin Schulz This should hopefully make it clearer what is expected from the contributor. This follows my understanding of git-commit(1)[1] where the following is a git commit message: """ git commit title git commit description """ I'm putting the "Fixes [YOCTO" line in "body of the commit message" so it's understood as being different from the git commit description so that the note admonition allowing us to have an empty commit description doesn't apply to the "Fixes [YOCTO" line. [1] https://www.man7.org/linux/man-pages/man1/git-commit.1.html#DISCUSSION Signed-off-by: Quentin Schulz --- documentation/contributor-guide/submit-changes.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 1de4b6c0ed838d1c4c225df06763f672ff7c27f1..49790ee14ed259c94b28bee548ca48b9e5977cb7 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -163,7 +163,7 @@ to add the upgraded version. this project or the open source license(s) involved. - Provide a single-line summary of the change and, if more - explanation is needed, provide more detail in the body of the + explanation is needed, provide more detail in the description of the commit. This summary is typically viewable in the "shortlist" of changes. Thus, providing something short and descriptive that gives the reader a summary of the change is useful when viewing a @@ -179,23 +179,23 @@ to add the upgraded version. git log --oneline - - For the body of the commit message, provide detailed information + - For the commit description, provide detailed information that describes what you changed, why you made the change, and the approach you used. It might also be helpful if you mention how you - tested the change. Provide as much detail as you can in the body - of the commit message. + tested the change. Provide as much detail as you can in the commit + description. .. note:: If the single line summary is enough to describe a simple - change, the body of the commit message can be left empty. + change, the commit description can be left empty. - If the change addresses a specific bug or issue that is associated - with a bug-tracking ID, include a reference to that ID in your - detailed description. For example, the Yocto Project uses a + with a bug-tracking ID, include a reference to that ID in the body of the + commit message. For example, the Yocto Project uses a specific convention for bug references --- any commit that addresses - a specific bug should use the following form for the detailed - description. Be sure to use the actual bug-tracking ID from + a specific bug should use the following form for the body of the commit + message. Be sure to use the actual bug-tracking ID from Bugzilla for bug-id:: single-line summary of change From patchwork Thu Sep 18 10:24:44 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 70486 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 4F66ACAC59A for ; Thu, 18 Sep 2025 10:25:02 +0000 (UTC) Received: from smtp-8fa8.mail.infomaniak.ch (smtp-8fa8.mail.infomaniak.ch [83.166.143.168]) by mx.groups.io with SMTP id smtpd.web11.10711.1758191094011804129 for ; Thu, 18 Sep 2025 03:24:54 -0700 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 83.166.143.168, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (unknown [IPv6:2001:1600:4:17::246c]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4cSBb846XZz68j; Thu, 18 Sep 2025 12:24:52 +0200 (CEST) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4cSBb815glzNnh; Thu, 18 Sep 2025 12:24:52 +0200 (CEST) From: Quentin Schulz Date: Thu, 18 Sep 2025 12:24:44 +0200 Subject: [PATCH 6/7] contributor-guide: submit-changes: number instruction list in commit your changes MIME-Version: 1.0 Message-Id: <20250918-submit-patches-v1-6-28abd2919df0@cherry.de> References: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> In-Reply-To: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> To: docs@lists.yoctoproject.org Cc: Barne Carstensen , Quentin Schulz X-Mailer: b4 0.14.2 X-Infomaniak-Routing: alpha 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 ; Thu, 18 Sep 2025 10:25:02 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7549 From: Quentin Schulz ... so that it's clear that you need to read and follow each and every instruction in this list. Signed-off-by: Quentin Schulz --- documentation/contributor-guide/submit-changes.rst | 116 ++++++++++----------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 49790ee14ed259c94b28bee548ca48b9e5977cb7..29af1ced959c86bd5b402d1a8000f11e3e760b8f 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -127,82 +127,82 @@ to add the upgraded version. $ git commit -sa - - The ``-s`` option of ``git commit`` adds a "Signed-off-by:" line - to your commit message. There is the same requirement for contributing - to the Linux kernel. Adding such a line signifies that you, the - submitter, have agreed to the `Developer's Certificate of Origin 1.1 - `__ - as follows: + #. The ``-s`` option of ``git commit`` adds a "Signed-off-by:" line + to your commit message. There is the same requirement for contributing + to the Linux kernel. Adding such a line signifies that you, the + submitter, have agreed to the `Developer's Certificate of Origin 1.1 + `__ + as follows: - .. code-block:: none + .. code-block:: none - Developer's Certificate of Origin 1.1 + Developer's Certificate of Origin 1.1 - By making a contribution to this project, I certify that: + By making a contribution to this project, I certify that: - (a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or + (a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or - (b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or + (b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or - (c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. + (c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. - (d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. + (d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. - - Provide a single-line summary of the change and, if more - explanation is needed, provide more detail in the description of the - commit. This summary is typically viewable in the "shortlist" of - changes. Thus, providing something short and descriptive that - gives the reader a summary of the change is useful when viewing a - list of many commits. You should prefix this short description - with the recipe name (if changing a recipe), or else with the - short form path to the file being changed. + #. Provide a single-line summary of the change and, if more + explanation is needed, provide more detail in the description of the + commit. This summary is typically viewable in the "shortlist" of + changes. Thus, providing something short and descriptive that + gives the reader a summary of the change is useful when viewing a + list of many commits. You should prefix this short description + with the recipe name (if changing a recipe), or else with the + short form path to the file being changed. - .. note:: + .. note:: - To find a suitable prefix for the commit summary, a good idea - is to look for prefixes used in previous commits touching the - same files or directories:: + To find a suitable prefix for the commit summary, a good idea + is to look for prefixes used in previous commits touching the + same files or directories:: - git log --oneline + git log --oneline - - For the commit description, provide detailed information - that describes what you changed, why you made the change, and the - approach you used. It might also be helpful if you mention how you - tested the change. Provide as much detail as you can in the commit - description. + #. For the commit description, provide detailed information + that describes what you changed, why you made the change, and the + approach you used. It might also be helpful if you mention how you + tested the change. Provide as much detail as you can in the commit + description. - .. note:: + .. note:: - If the single line summary is enough to describe a simple - change, the commit description can be left empty. + If the single line summary is enough to describe a simple + change, the commit description can be left empty. - - If the change addresses a specific bug or issue that is associated - with a bug-tracking ID, include a reference to that ID in the body of the - commit message. For example, the Yocto Project uses a - specific convention for bug references --- any commit that addresses - a specific bug should use the following form for the body of the commit - message. Be sure to use the actual bug-tracking ID from - Bugzilla for bug-id:: + #. If the change addresses a specific bug or issue that is associated + with a bug-tracking ID, include a reference to that ID in the body of the + commit message. For example, the Yocto Project uses a + specific convention for bug references --- any commit that addresses + a specific bug should use the following form for the body of the commit + message. Be sure to use the actual bug-tracking ID from + Bugzilla for bug-id:: - single-line summary of change + single-line summary of change - Fixes [YOCTO #bug-id] + Fixes [YOCTO #bug-id] - detailed description of change + detailed description of change #. *Crediting contributors:* By using the ``git commit --amend`` command, you can add some tags to the commit description to credit other contributors From patchwork Thu Sep 18 10:24:45 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 70485 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 50F69CAC5A8 for ; Thu, 18 Sep 2025 10:25:02 +0000 (UTC) Received: from smtp-190e.mail.infomaniak.ch (smtp-190e.mail.infomaniak.ch [185.125.25.14]) by mx.groups.io with SMTP id smtpd.web11.10712.1758191094452425707 for ; Thu, 18 Sep 2025 03:24:54 -0700 Authentication-Results: mx.groups.io; dkim=none (message not signed); spf=pass (domain: 0leil.net, ip: 185.125.25.14, mailfrom: foss+yocto@0leil.net) Received: from smtp-3-0001.mail.infomaniak.ch (smtp-3-0001.mail.infomaniak.ch [10.4.36.108]) by smtp-3-3000.mail.infomaniak.ch (Postfix) with ESMTPS id 4cSBb902yZzKLM; Thu, 18 Sep 2025 12:24:53 +0200 (CEST) Received: from unknown by smtp-3-0001.mail.infomaniak.ch (Postfix) with ESMTPA id 4cSBb84CqHzLrw; Thu, 18 Sep 2025 12:24:52 +0200 (CEST) From: Quentin Schulz Date: Thu, 18 Sep 2025 12:24:45 +0200 Subject: [PATCH 7/7] contributor-guide: submit-changes: make "Crediting contributors" part of "Commit your changes" MIME-Version: 1.0 Message-Id: <20250918-submit-patches-v1-7-28abd2919df0@cherry.de> References: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> In-Reply-To: <20250918-submit-patches-v1-0-28abd2919df0@cherry.de> To: docs@lists.yoctoproject.org Cc: Barne Carstensen , Quentin Schulz X-Mailer: b4 0.14.2 X-Infomaniak-Routing: alpha 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 ; Thu, 18 Sep 2025 10:25:02 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7550 From: Quentin Schulz There's no need to differentiate crediting contributors from committing your changes, so let's simply make it the last step of "Commit your changes" section. This simply indents the text so it's now part of "Commit your changes" list instead of the main list in the "Implement and commit changes" section. Because of this reorganisation, the instruction to use "git commit --amend" to add the contributors is moved to a note, and the first few sentences are reworded to better match the wording of other items in the "Commit your changes" list of instructions. Signed-off-by: Quentin Schulz --- documentation/contributor-guide/submit-changes.rst | 44 ++++++++++++---------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 29af1ced959c86bd5b402d1a8000f11e3e760b8f..e3b29500d348be7ca273ac0d3b7d5d825c752579 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -204,31 +204,35 @@ to add the upgraded version. detailed description of change -#. *Crediting contributors:* By using the ``git commit --amend`` command, - you can add some tags to the commit description to credit other contributors - to the change: + #. If other people participated in this patch, add some tags to the commit + description to credit other contributors to the change: - - ``Reported-by``: name and email of a person reporting a bug - that your commit is trying to fix. This is a good practice - to encourage people to go on reporting bugs and let them - know that their reports are taken into account. + - ``Reported-by``: name and email of a person reporting a bug + that your commit is trying to fix. This is a good practice + to encourage people to go on reporting bugs and let them + know that their reports are taken into account. - - ``Suggested-by``: name and email of a person to credit for the - idea of making the change. + - ``Suggested-by``: name and email of a person to credit for the + idea of making the change. - - ``Tested-by``, ``Reviewed-by``: name and email for people having - tested your changes or reviewed their code. These fields are - usually added by the maintainer accepting a patch, or by - yourself if you submitted your patches to early reviewers, - or are submitting an unmodified patch again as part of a - new iteration of your patch series. + - ``Tested-by``, ``Reviewed-by``: name and email for people having + tested your changes or reviewed their code. These fields are + usually added by the maintainer accepting a patch, or by + yourself if you submitted your patches to early reviewers, + or are submitting an unmodified patch again as part of a + new iteration of your patch series. - - ``Cc``: name and email of people you want to send a copy - of your changes to. This field will be used by ``git send-email``. + - ``Cc``: name and email of people you want to send a copy + of your changes to. This field will be used by ``git send-email``. - See `more guidance about using such tags - `__ - in the Linux kernel documentation. + See `more guidance about using such tags + `__ + in the Linux kernel documentation. + + .. note:: + + One can amend an existing git commit message to add missing tags for + contributors with the ``git commit --amend`` command. Test your changes -----------------