diff options
| author | Russell Bryant <russell@ovn.org> | 2015-12-09 14:04:01 -0500 |
|---|---|---|
| committer | Russell Bryant <russell@ovn.org> | 2015-12-09 16:27:05 -0500 |
| commit | 5a6b18a979ddda3f9cd8ff774397a9ad02bdc20f (patch) | |
| tree | f4bc98d561ca6eba2fd7ec900b2afeee2d090410 /CONTRIBUTING.md | |
| parent | 042852d14cabb1d91fefc9f6ce713796d8459086 (diff) | |
| download | openvswitch-5a6b18a979ddda3f9cd8ff774397a9ad02bdc20f.tar.gz | |
CONTRIBUTING: Document the Fixes header.
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>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97ab9cb84..1e1d573c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -231,6 +231,16 @@ 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. 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 --------------------------------- |