[PATCH] docs: process: Add an example for creating a fixes tag

[PATCH] docs: process: Add an example for creating a fixes tag

[trix]

From: Tom Rix <trix@redhat.com>

To make it a little clearer how to create a fixes tag,
add an example based on the preceeding gitconfig setup.

Signed-off-by: Tom Rix <trix@redhat.com>
---
 Documentation/process/submitting-patches.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index e58b2c541d25..5219bf3cddfc 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -196,6 +196,11 @@ outputting the above style in the ``git log`` or ``git show`` commands::
 	[pretty]
 		fixes = Fixes: %h (\"%s\")
 
+An example call::
+
+	$ git log -1 --pretty=fixes 54a4f0239f2e
+	Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
+
 .. _split_changes:
 
 3) Separate your changes
-- 
2.18.1

Re: [PATCH] docs: process: Add an example for creating a fixes tag

[Jonathan Corbet]

On Fri, 10 Jul 2020 13:01:15 -0700
trix@redhat.com wrote:

> To make it a little clearer how to create a fixes tag,
> add an example based on the preceeding gitconfig setup.
> 
> Signed-off-by: Tom Rix <trix@redhat.com>
> ---
>  Documentation/process/submitting-patches.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
> index e58b2c541d25..5219bf3cddfc 100644
> --- a/Documentation/process/submitting-patches.rst
> +++ b/Documentation/process/submitting-patches.rst
> @@ -196,6 +196,11 @@ outputting the above style in the ``git log`` or ``git show`` commands::
>  	[pretty]
>  		fixes = Fixes: %h (\"%s\")
>  
> +An example call::
> +
> +	$ git log -1 --pretty=fixes 54a4f0239f2e
> +	Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
> +

Sure, why not?  Applied, thanks.

jon