Re: [docs] [PATCH] contributor-guide: recommend format.forceInBodyFrom

Joshua Watt
2024-05-02T19:26:10Z

On Thu, May 2, 2024 at 1:18 PM Alexandre Belloni via
lists.yoctoproject.org
<alexandre.belloni=bootlin.com@lists.yoctoproject.org> wrote:
>
> On 02/05/2024 08:27:02-0700, Tim Orling wrote:
> > 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
> > +
>
> I do believe the current documentation already points to a working
> solution:
>
> https://docs.yoctoproject.org/contributor-guide/submit-changes.html#fixing-your-from-identity
>
> Doesn't that work for you?

Empirically, that is insufficient. I've had that set and it mangled my
From line anyway. I beleive that only affects the SMTP header From,
when you actually need the "correct" From in the message body as a Git
header (which is what format.forceInBodyFrom does). Besides, most
people probably already set that anyway because I think it prompts if
you don't have it set

>
> > Clone the Git repository for the component to modify
> > ----------------------------------------------------
> >
> > --
> > 2.43.2
> >
> >
>
> --
> Alexandre Belloni, co-owner and COO, Bootlin
> Embedded Linux and Kernel engineering
> https://bootlin.com
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#5205): https://lists.yoctoproject.org/g/docs/message/5205
> Mute This Topic: https://lists.yoctoproject.org/mt/105864996/3616693
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [JPEWhacker@gmail.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>