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

Tim Orling
2024-05-02T16:12:17Z

[-- Attachment #1: Type: text/plain, Size: 2255 bytes --]

On Thu, May 2, 2024 at 8:38 AM Joshua Watt via lists.yoctoproject.org
<JPEWhacker=gmail.com@lists.yoctoproject.org> wrote:

> On Thu, May 2, 2024 at 9:27 AM Tim Orling via lists.yoctoproject.org
> <tim.orling=konsulko.com@lists.yoctoproject.org> 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
> > +
>
> This is good, but we will probably need to clarify that there is a git
> version dependency here. Git 2.34.1 (at least) doesn't have this
> option. I'm not sure when it was added. It appears that 2.34 is the
> version that ships with Ubuntu 22.04
>

Looks like it was introduced in 2.38.0, I think?
https://github.com/git/git/commit/d5fc07df688ace8c5a32f66b358ebd55cdaf4d28

>
> > Clone the Git repository for the component to modify
> > ----------------------------------------------------
> >
> > --
> > 2.43.2
> >
> >
> >
> >
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#5200):
> https://lists.yoctoproject.org/g/docs/message/5200
> Mute This Topic: https://lists.yoctoproject.org/mt/105864996/924729
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [
> ticotimo@gmail.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>
>

[-- Attachment #2: Type: text/html, Size: 3869 bytes --]