Re: [docs] [PATCH 0/1] YP overview manual: style improvements

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Michael Opdenacker]

Hello,

On 3/30/21 5:19 PM, Michael Opdenacker wrote:
> Thanks in advance for your reviews!


Sorry, I missed again! When I sent the e-mail to myself, both the cover
letter and patch were on the same thread.

But, when I sent to the list, I lost that. Here's the command I used (I
referred to "man git-send-email"):

git send-email --compose --thread --no-chain-reply --to docs@lists.yoctoproject.org 0001-YP-overview-manual-style-improvements.patch

What would you do to have both messages in the same thread? I mean,
without having to run "git send-email" twice, the second time with
"--in-reply-to=".

Apologies again for the noise...

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Quentin Schulz]

Hi Michael,

On Tue, Mar 30, 2021 at 05:27:41PM +0200, Michael Opdenacker wrote:
> Hello,
> 
> On 3/30/21 5:19 PM, Michael Opdenacker wrote:
> > Thanks in advance for your reviews!
> 
> 
> Sorry, I missed again! When I sent the e-mail to myself, both the cover
> letter and patch were on the same thread.
> 
> But, when I sent to the list, I lost that. Here's the command I used (I
> referred to "man git-send-email"):
> 
> git send-email --compose --thread --no-chain-reply --to docs@lists.yoctoproject.org 0001-YP-overview-manual-style-improvements.patch
> 

git format-patch --cover-letter <commit-hash>

(refer to man git-format-patch for the logic behind the <commit-hash>
 parameter)

Edit the cover letter manually.

git send-email --to docs@lists.yoctoproject.org *.patch

From memory, so it might be slightly different in reality.

Cheers,
Quentin

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Quentin Schulz]

On Tue, Mar 30, 2021 at 05:34:00PM +0200, Quentin Schulz wrote:
> Hi Michael,
> 
> On Tue, Mar 30, 2021 at 05:27:41PM +0200, Michael Opdenacker wrote:
> > Hello,
> > 
> > On 3/30/21 5:19 PM, Michael Opdenacker wrote:
> > > Thanks in advance for your reviews!
> > 
> > 
> > Sorry, I missed again! When I sent the e-mail to myself, both the cover
> > letter and patch were on the same thread.
> > 

They seem to be on the same mail thread in my mail client, not sure if
anyone else than you has the issue?

It is possible your mail client is confused because git send-email will
add yourself to the recipients (since you're the author and added your
SoB), so you might receive the mail twice, once from the mailing list,
once "from" git send-email (your own mail server reading the recipients
basically).

Quentin

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Nicolas Dechesne]

On 3/30/21 5:36 PM, Quentin Schulz wrote:
> On Tue, Mar 30, 2021 at 05:34:00PM +0200, Quentin Schulz wrote:
>> Hi Michael,
>>
>> On Tue, Mar 30, 2021 at 05:27:41PM +0200, Michael Opdenacker wrote:
>>> Hello,
>>>
>>> On 3/30/21 5:19 PM, Michael Opdenacker wrote:
>>>> Thanks in advance for your reviews!
>>>
>>>
>>> Sorry, I missed again! When I sent the e-mail to myself, both the cover
>>> letter and patch were on the same thread.
>>>
> 
> They seem to be on the same mail thread in my mail client, not sure if
> anyone else than you has the issue?

Looks fine for me too.
However please avoid cover letter when you have just one patch. You can 
add additional information when you send one email, if you add it after 
the commit message (after the ---), this will not be used when applying 
the patch.
	
> 
> It is possible your mail client is confused because git send-email will
> add yourself to the recipients (since you're the author and added your
> SoB), so you might receive the mail twice, once from the mailing list,
> once "from" git send-email (your own mail server reading the recipients
> basically).
> 
> Quentin
> 
> 
> 
> 
> 

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Michael Opdenacker]

Hi Quentin,

Thanks for your advise!

> git format-patch --cover-letter <commit-hash>
>
> (refer to man git-format-patch for the logic behind the <commit-hash>
>  parameter)
>
> Edit the cover letter manually.


Good, I'll try that!

>
> git send-email --to docs@lists.yoctoproject.org *.patch

Thanks! I had the wrong belief that git send-email was sending by
default to separate threads. I tested again and you are obviously right.

Michael.


-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Michael Opdenacker]

Hi again Quentin,

On 3/30/21 5:36 PM, Quentin Schulz wrote:
> On Tue, Mar 30, 2021 at 05:34:00PM +0200, Quentin Schulz wrote:
>> Hi Michael,
>>
>> On Tue, Mar 30, 2021 at 05:27:41PM +0200, Michael Opdenacker wrote:
>>> Hello,
>>>
>>> On 3/30/21 5:19 PM, Michael Opdenacker wrote:
>>>> Thanks in advance for your reviews!
>>>
>>> Sorry, I missed again! When I sent the e-mail to myself, both the cover
>>> letter and patch were on the same thread.
>>>
> They seem to be on the same mail thread in my mail client, not sure if
> anyone else than you has the issue?
>
> It is possible your mail client is confused because git send-email will
> add yourself to the recipients (since you're the author and added your
> SoB), so you might receive the mail twice, once from the mailing list,
> once "from" git send-email (your own mail server reading the recipients
> basically).


Yes, indeed, I checked after removing the message sent directly to me,
just keeping the messages from the list.

It's good to know that you and Nicolas see the same e-mail thread. There
is a reference to the first message in the second one, so most probably
my e-mail client (Thunderbird) and the web interface on
https://lists.yoctoproject.org/g/docs/topics are confused because they
both see two different threads.

I'll file a bug on https://lists.yoctoproject.org in case that's just a
configuration issue.

Thanks!

Michael.

-- 

Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Michael Opdenacker]

Hi Nicolas,

On 3/30/21 5:42 PM, Nicolas Dechesne wrote:
> On 3/30/21 5:36 PM, Quentin Schulz wrote:
>
> Looks fine for me too.
> However please avoid cover letter when you have just one patch. You
> can add additional information when you send one email, if you add it
> after the commit message (after the ---), this will not be used when
> applying the patch.


Very good to know! I'll do that next time.
Indeed, I didn't want to provide some context by replying to my patch.

Or maybe I'm just being too verbose ;-)

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Peter Kjellerstedt]

> -----Original Message-----
> From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf
> Of Michael Opdenacker
> Sent: den 30 mars 2021 18:25
> To: Nicolas Dechesne <nicolas.dechesne@linaro.org>; Quentin Schulz
> <quentin.schulz@streamunlimited.com>
> Cc: docs@lists.yoctoproject.org
> Subject: Re: [docs] [PATCH 0/1] YP overview manual: style improvements
> 
> Hi Nicolas,
> 
> On 3/30/21 5:42 PM, Nicolas Dechesne wrote:
> > On 3/30/21 5:36 PM, Quentin Schulz wrote:
> >
> > Looks fine for me too.
> > However please avoid cover letter when you have just one patch. You
> > can add additional information when you send one email, if you add it
> > after the commit message (after the ---), this will not be used when
> > applying the patch.
> 
> 
> Very good to know! I'll do that next time.
> Indeed, I didn't want to provide some context by replying to my patch.
> 
> Or maybe I'm just being too verbose ;-)
> 
> Michael.

Please make sure to prefix the commit subjects with a relevant document 
or similar, just like we do for all commits to, e.g., OE-Core. Contrary 
to, e.g., commits in the bitbake repository, there is no prefix added 
when the commits to the documentation repository are included in poky, 
making these commit stand out and lacking context when using, e.g., 
`git log --oneline`. Look back through the git log to get examples of 
how this has traditionally been done.

//Peter

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Peter Kjellerstedt]

> -----Original Message-----
> From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf
> Of Peter Kjellerstedt
> Sent: den 31 mars 2021 18:40
> To: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Cc: docs@lists.yoctoproject.org
> Subject: Re: [docs] [PATCH 0/1] YP overview manual: style improvements
> 
> > -----Original Message-----
> > From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On
> Behalf
> > Of Michael Opdenacker
> > Sent: den 30 mars 2021 18:25
> > To: Nicolas Dechesne <nicolas.dechesne@linaro.org>; Quentin Schulz
> > <quentin.schulz@streamunlimited.com>
> > Cc: docs@lists.yoctoproject.org
> > Subject: Re: [docs] [PATCH 0/1] YP overview manual: style improvements
> >
> > Hi Nicolas,
> >
> > On 3/30/21 5:42 PM, Nicolas Dechesne wrote:
> > > On 3/30/21 5:36 PM, Quentin Schulz wrote:
> > >
> > > Looks fine for me too.
> > > However please avoid cover letter when you have just one patch. You
> > > can add additional information when you send one email, if you add it
> > > after the commit message (after the ---), this will not be used when
> > > applying the patch.
> >
> >
> > Very good to know! I'll do that next time.
> > Indeed, I didn't want to provide some context by replying to my patch.
> >
> > Or maybe I'm just being too verbose ;-)
> >
> > Michael.
> 
> Please make sure to prefix the commit subjects with a relevant document
> or similar, just like we do for all commits to, e.g., OE-Core. Contrary
> to, e.g., commits in the bitbake repository, there is no prefix added
> when the commits to the documentation repository are included in poky,
> making these commit stand out and lacking context when using, e.g.,
> `git log --oneline`. Look back through the git log to get examples of
> how this has traditionally been done.
> 
> //Peter

And I of course chose a bad example mail to respond to as this one actually 
has a prefix. ;)

//Peter

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Nicolas Dechesne]

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

On Wed, Mar 31, 2021 at 6:44 PM Peter Kjellerstedt <
peter.kjellerstedt@axis.com> wrote:

> > -----Original Message-----
> > From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On
> Behalf
> > Of Peter Kjellerstedt
> > Sent: den 31 mars 2021 18:40
> > To: Michael Opdenacker <michael.opdenacker@bootlin.com>
> > Cc: docs@lists.yoctoproject.org
> > Subject: Re: [docs] [PATCH 0/1] YP overview manual: style improvements
> >
> > > -----Original Message-----
> > > From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On
> > Behalf
> > > Of Michael Opdenacker
> > > Sent: den 30 mars 2021 18:25
> > > To: Nicolas Dechesne <nicolas.dechesne@linaro.org>; Quentin Schulz
> > > <quentin.schulz@streamunlimited.com>
> > > Cc: docs@lists.yoctoproject.org
> > > Subject: Re: [docs] [PATCH 0/1] YP overview manual: style improvements
> > >
> > > Hi Nicolas,
> > >
> > > On 3/30/21 5:42 PM, Nicolas Dechesne wrote:
> > > > On 3/30/21 5:36 PM, Quentin Schulz wrote:
> > > >
> > > > Looks fine for me too.
> > > > However please avoid cover letter when you have just one patch. You
> > > > can add additional information when you send one email, if you add it
> > > > after the commit message (after the ---), this will not be used when
> > > > applying the patch.
> > >
> > >
> > > Very good to know! I'll do that next time.
> > > Indeed, I didn't want to provide some context by replying to my patch.
> > >
> > > Or maybe I'm just being too verbose ;-)
> > >
> > > Michael.
> >
> > Please make sure to prefix the commit subjects with a relevant document
> > or similar, just like we do for all commits to, e.g., OE-Core. Contrary
> > to, e.g., commits in the bitbake repository, there is no prefix added
> > when the commits to the documentation repository are included in poky,
> > making these commit stand out and lacking context when using, e.g.,
> > `git log --oneline`. Look back through the git log to get examples of
> > how this has traditionally been done.
> >
> > //Peter
>
> And I of course chose a bad example mail to respond to as this one
> actually
> has a prefix. ;)
>

well. now that you say it... i think the prefix should be
'overview-manual'  , or 'ref-manual' if we look at past commits!


>
> //Peter
>
>
> 
>
>

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

Re: [docs] [PATCH 0/1] YP overview manual: style improvements

[Michael Opdenacker]

Hi Peter,

On 3/31/21 6:39 PM, Peter Kjellerstedt wrote:
> Please make sure to prefix the commit subjects with a relevant document 
> or similar, just like we do for all commits to, e.g., OE-Core. Contrary 
> to, e.g., commits in the bitbake repository, there is no prefix added 
> when the commits to the documentation repository are included in poky, 
> making these commit stand out and lacking context when using, e.g., 
> `git log --oneline`. Look back through the git log to get examples of 
> how this has traditionally been done.


Thank you for the advise; it definitely makes sense when understanding
the Poky constraints.

I split the patch into 2 different commits with a proper subject header.
They are now in branch "master-next".

Thanks again,

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com