mir/ovs
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-09-02 15:25:22 +00:00
Code Issues Releases Wiki Activity

CONTRIBUTING: Document the Fixes header.

Browse Source 
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>
Acked-by: Joe Stringer <joe@ovn.org>
This commit is contained in:
Russell Bryant
2015-12-09 14:04:01 -05:00
parent 042852d14c
commit 5a6b18a979
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -231,6 +231,16 @@ Examples of common tags follow.
in old change log entries. (They are obsolete because they do in old change log entries. (They are obsolete because they do
not tell the reader what bug tracker is referred to.) 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. This assists in determining
which OVS releases have the bug, so the patch can be applied to all
affected versions. 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 Developer's Certificate of Origin
--------------------------------- ---------------------------------