[PATCH] doc: Add git commands to generate Fixes

[PATCH] doc: Add git commands to generate Fixes

[Bertrand Marquis]

Add git commands examples that can be used to generate fixes and how to
use the pretty configuration for git.
This should make it easier for contributors to have the right format.

Signed-off-by: Bertrand Marquis <bertrand.marquis@arm.com>
---
 docs/process/sending-patches.pandoc | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/process/sending-patches.pandoc b/docs/process/sending-patches.pandoc
index 7ff7826c992b..9c4c4655323b 100644
--- a/docs/process/sending-patches.pandoc
+++ b/docs/process/sending-patches.pandoc
@@ -102,6 +102,10 @@ E.g.:
 
     Fixes: 67d01cdb5518 ("x86: infrastructure to allow converting certain indirect calls to direct ones")
 
+If git was configured as explained earlier, this can be retrieved using
+``git log --pretty=fixes`` otherwise ``git log --abbrev=12 --oneline`` will
+give the proper tag and title.
+
 ### Backport:
 
 A backport tag is an optional tag in the commit message to request a
-- 
2.25.1

Re: [PATCH] doc: Add git commands to generate Fixes

[Stefano Stabellini]

On Wed, 3 Aug 2022, Bertrand Marquis wrote:
> Add git commands examples that can be used to generate fixes and how to
> use the pretty configuration for git.
> This should make it easier for contributors to have the right format.
> 
> Signed-off-by: Bertrand Marquis <bertrand.marquis@arm.com>

Acked-by: Stefano Stabellini <sstabellini@kernel.org>


> ---
>  docs/process/sending-patches.pandoc | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/docs/process/sending-patches.pandoc b/docs/process/sending-patches.pandoc
> index 7ff7826c992b..9c4c4655323b 100644
> --- a/docs/process/sending-patches.pandoc
> +++ b/docs/process/sending-patches.pandoc
> @@ -102,6 +102,10 @@ E.g.:
>  
>      Fixes: 67d01cdb5518 ("x86: infrastructure to allow converting certain indirect calls to direct ones")
>  
> +If git was configured as explained earlier, this can be retrieved using
> +``git log --pretty=fixes`` otherwise ``git log --abbrev=12 --oneline`` will
> +give the proper tag and title.
> +
>  ### Backport:
>  
>  A backport tag is an optional tag in the commit message to request a
> -- 
> 2.25.1
~ 

Re: [PATCH] doc: Add git commands to generate Fixes

[Julien Grall]

Hi Bertrand,

On 03/08/2022 15:43, Bertrand Marquis wrote:
> Add git commands examples that can be used to generate fixes and how to
> use the pretty configuration for git.
> This should make it easier for contributors to have the right format.
> 
> Signed-off-by: Bertrand Marquis <bertrand.marquis@arm.com>
> ---
>   docs/process/sending-patches.pandoc | 4 ++++
>   1 file changed, 4 insertions(+)
> 
> diff --git a/docs/process/sending-patches.pandoc b/docs/process/sending-patches.pandoc
> index 7ff7826c992b..9c4c4655323b 100644
> --- a/docs/process/sending-patches.pandoc
> +++ b/docs/process/sending-patches.pandoc
> @@ -102,6 +102,10 @@ E.g.:
>   
>       Fixes: 67d01cdb5518 ("x86: infrastructure to allow converting certain indirect calls to direct ones")
>   
> +If git was configured as explained earlier, this can be retrieved using
> +``git log --pretty=fixes`` otherwise ``git log --abbrev=12 --oneline`` will
> +give the proper tag and title.

Rather than "proper tag", do you mean "commit-id"?

Other than that:

Acked-by: Julien Grall <jgrall@amazon.com>

Cheers,

-- 
Julien Grall

Re: [PATCH] doc: Add git commands to generate Fixes

[Bertrand Marquis]

> On 4 Aug 2022, at 14:38, Julien Grall <julien@xen.org> wrote:
> 
> Hi Bertrand,
> 
> On 03/08/2022 15:43, Bertrand Marquis wrote:
>> Add git commands examples that can be used to generate fixes and how to
>> use the pretty configuration for git.
>> This should make it easier for contributors to have the right format.
>> Signed-off-by: Bertrand Marquis <bertrand.marquis@arm.com>
>> ---
>>  docs/process/sending-patches.pandoc | 4 ++++
>>  1 file changed, 4 insertions(+)
>> diff --git a/docs/process/sending-patches.pandoc b/docs/process/sending-patches.pandoc
>> index 7ff7826c992b..9c4c4655323b 100644
>> --- a/docs/process/sending-patches.pandoc
>> +++ b/docs/process/sending-patches.pandoc
>> @@ -102,6 +102,10 @@ E.g.:
>>        Fixes: 67d01cdb5518 ("x86: infrastructure to allow converting certain indirect calls to direct ones")
>>  +If git was configured as explained earlier, this can be retrieved using
>> +``git log --pretty=fixes`` otherwise ``git log --abbrev=12 --oneline`` will
>> +give the proper tag and title.
> 
> Rather than "proper tag", do you mean "commit-id"?

Yes you are right commit-id is better.
Can you fix on commit ? 

> 
> Other than that:
> 
> Acked-by: Julien Grall <jgrall@amazon.com>
> 

Thanks
Bertrand

> Cheers,
> 
> -- 
> Julien Grall

Re: [PATCH] doc: Add git commands to generate Fixes

[Julien Grall]

Hi Bertrand,

On 04/08/2022 16:07, Bertrand Marquis wrote:
> 
> 
>> On 4 Aug 2022, at 14:38, Julien Grall <julien@xen.org> wrote:
>>
>> Hi Bertrand,
>>
>> On 03/08/2022 15:43, Bertrand Marquis wrote:
>>> Add git commands examples that can be used to generate fixes and how to
>>> use the pretty configuration for git.
>>> This should make it easier for contributors to have the right format.
>>> Signed-off-by: Bertrand Marquis <bertrand.marquis@arm.com>
>>> ---
>>>   docs/process/sending-patches.pandoc | 4 ++++
>>>   1 file changed, 4 insertions(+)
>>> diff --git a/docs/process/sending-patches.pandoc b/docs/process/sending-patches.pandoc
>>> index 7ff7826c992b..9c4c4655323b 100644
>>> --- a/docs/process/sending-patches.pandoc
>>> +++ b/docs/process/sending-patches.pandoc
>>> @@ -102,6 +102,10 @@ E.g.:
>>>         Fixes: 67d01cdb5518 ("x86: infrastructure to allow converting certain indirect calls to direct ones")
>>>   +If git was configured as explained earlier, this can be retrieved using
>>> +``git log --pretty=fixes`` otherwise ``git log --abbrev=12 --oneline`` will
>>> +give the proper tag and title.
>>
>> Rather than "proper tag", do you mean "commit-id"?
> 
> Yes you are right commit-id is better.
> Can you fix on commit ?

Sure. It is now committed.

Cheers,

-- 
Julien Grall