[ovs-dev] [PATCH] CONTRIBUTING.md: Improve recommended command for Fixes: header.
Ben Pfaff
blp at ovn.org
Fri Sep 23 15:28:55 UTC 2016
It usually makes sense to CC the author of the commit being fixed.
The CC tag wasn't mentioned before, so describe it too.
Signed-off-by: Ben Pfaff <blp at ovn.org>
---
CONTRIBUTING.md | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 68442d2..6dc3a92 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -202,6 +202,15 @@ Examples of common tags follow.
not always be appropriate to publicly give credit. If in
doubt, please ask.)
+ CC: Person <name at email>
+
+ This is a way to tag a patch for the attention of a person
+ when no more specific tag is appropriate. One use is to
+ request a review from a particular person. It doesn't make
+ sense to include the same person in CC and another tag, so
+ e.g. if someone who is CCed later provides an Acked-by, add
+ the Acked-by and remove the CC at the same time.
+
Reported-at: <URL>
If a patch fixes or is otherwise related to a bug reported in
@@ -246,9 +255,11 @@ Examples of common tags follow.
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:
+ proper format is with this git command. This command also CCs the
+ author of the commit being fixed, which makes sense unless the
+ author also made the fix or is already named in another tag:
- git log -1 --pretty=format:"Fixes: %h (\"%s\")" --abbrev=12 COMMIT_REF
+ git log -1 --pretty=format:"CC: %an <%ae>%nFixes: %h (\"%s\")" --abbrev=12 COMMIT_REF
Vulnerability: CVE-2016-2074
--
2.1.3
More information about the dev
mailing list