($INBOX_DIR/description missing)
 help / color / mirror / Atom feed
From: Tim Orling <tim.orling@konsulko.com>
To: docs@lists.yoctoproject.org
Cc: Tim Orling <tim.orling@konsulko.com>
Subject: [PATCH] contributor-guide: recommend format.forceInBodyFrom
Date: Thu,  2 May 2024 08:27:02 -0700	[thread overview]
Message-ID: <20240502152701.1798568-2-tim.orling@konsulko.com> (raw)

We are seeing a lot of patches failing when the From:
line is not contained in the message body. It is probably
better to just recommend to force the in-body From: to be
present globally.

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
 documentation/contributor-guide/submit-changes.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 47a416b24..c292a143a 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -65,6 +65,11 @@ use to identify your commits::
    git config --global user.name "Ada Lovelace"
    git config --global user.email "ada.lovelace@gmail.com"
 
+To ensure that your patches are formatted properly, it is also
+recommended to set::
+
+   git config --global format.forceInBodyFrom true
+
 Clone the Git repository for the component to modify
 ----------------------------------------------------
 
-- 
2.43.2



             reply	other threads:[~2024-05-02 15:27 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-02 15:27 Tim Orling [this message]
2024-05-02 15:37 ` [docs] [PATCH] contributor-guide: recommend format.forceInBodyFrom Joshua Watt
2024-05-02 16:12   ` Tim Orling
     [not found]   ` <17CBB7F2FCD711F1.29540@lists.yoctoproject.org>
2024-05-02 16:23     ` Tim Orling
2024-05-02 19:18 ` Alexandre Belloni
2024-05-02 19:25   ` [docs] " Joshua Watt
2024-05-02 19:45     ` Alexandre Belloni
2024-05-02 20:15       ` Alexander Kanavin
2024-05-02 20:22         ` Tim Orling
2024-05-02 20:53           ` Alexander Kanavin
     [not found]           ` <17CBC7546C174761.19168@lists.yoctoproject.org>
2024-05-03  9:23             ` Alexander Kanavin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240502152701.1798568-2-tim.orling@konsulko.com \
    --to=tim.orling@konsulko.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).