| Message ID | 1449687911-22137-1-git-send-email-russell@ovn.org |
|---|---|
| State | Accepted |
| Headers | show |
On 9 December 2015 at 11:05, Russell Bryant <russell@ovn.org> wrote: > Document the use of the Fixes header to refer to a commit that > introduced a bug being fixed. > > Signed-off-by: Russell Bryant <russell@ovn.org> > --- > CONTRIBUTING.md | 8 ++++++++ > 1 file changed, 8 insertions(+) > > diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md > index 97ab9cb..247c1d9 100644 > --- a/CONTRIBUTING.md > +++ b/CONTRIBUTING.md > @@ -231,6 +231,14 @@ Examples of common tags follow. > in old change log entries. (They are obsolete because they do > not tell the reader what bug tracker is referred to.) > > + Fixes: 63bc9fb1c69f (“packets: Reorder CS_* flags to remove gap.”) > + > + If you would like to record which commit introduced a bug being fixed, > + you may do that with a “Fixes” header. The easiest way to generate the > + header in the proper format is with this git command: > + > + git log -1 --pretty=format:”Fixes: %h (\”%s\”)” --abbrev=12 COMMIT_REF > + I tried copy/pasting/using this command, and it failed. Seems like the speech marks are the wrong kind, you need these instead: " A single sentence something like "This assists in determining which OVS releases have the bug, so the patch can be applied to all affected versions" might be handy so people have more context on when it should be used. Other than that, looks good to me, thanks for the patch! Acked-by: Joe Stringer <joe@ovn.org>
On 12/09/2015 02:35 PM, Joe Stringer wrote: > On 9 December 2015 at 11:05, Russell Bryant <russell@ovn.org> wrote: >> Document the use of the Fixes header to refer to a commit that >> introduced a bug being fixed. >> >> Signed-off-by: Russell Bryant <russell@ovn.org> >> --- >> CONTRIBUTING.md | 8 ++++++++ >> 1 file changed, 8 insertions(+) >> >> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md >> index 97ab9cb..247c1d9 100644 >> --- a/CONTRIBUTING.md >> +++ b/CONTRIBUTING.md >> @@ -231,6 +231,14 @@ Examples of common tags follow. >> in old change log entries. (They are obsolete because they do >> not tell the reader what bug tracker is referred to.) >> >> + Fixes: 63bc9fb1c69f (“packets: Reorder CS_* flags to remove gap.”) >> + >> + If you would like to record which commit introduced a bug being fixed, >> + you may do that with a “Fixes” header. The easiest way to generate the >> + header in the proper format is with this git command: >> + >> + git log -1 --pretty=format:”Fixes: %h (\”%s\”)” --abbrev=12 COMMIT_REF >> + > > I tried copy/pasting/using this command, and it failed. Seems like the > speech marks are the wrong kind, you need these instead: " Weird. Something automatically converted that copy/pasting it around. I'll fix. > A single sentence something like "This assists in determining which > OVS releases have the bug, so the patch can be applied to all affected > versions" might be handy so people have more context on when it should > be used. Great point. I'll use your suggested text. > Other than that, looks good to me, thanks for the patch! > > Acked-by: Joe Stringer <joe@ovn.org> Thanks! I'll apply this with your suggested fixes in a moment.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97ab9cb..247c1d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -231,6 +231,14 @@ Examples of common tags follow. in old change log entries. (They are obsolete because they do not tell the reader what bug tracker is referred to.) + Fixes: 63bc9fb1c69f (“packets: Reorder CS_* flags to remove gap.”) + + If you would like to record which commit introduced a bug being fixed, + you may do that with a “Fixes” header. The easiest way to generate the + header in the proper format is with this git command: + + git log -1 --pretty=format:”Fixes: %h (\”%s\”)” --abbrev=12 COMMIT_REF + Developer's Certificate of Origin ---------------------------------
Document the use of the Fixes header to refer to a commit that introduced a bug being fixed. Signed-off-by: Russell Bryant <russell@ovn.org> --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+)