From: Kefu Chai <kchai@redhat.com>
Date: Wed, 20 Jan 2016 08:23:04 +0000 (+0800)
Subject: SubmittingPatches: add doc for "Fixes:" tag
X-Git-Tag: v10.0.4~189^2~3
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=dbabbd03b79bcf58466e7a3e8b162cca3b42619a;p=ceph.git

SubmittingPatches: add doc for "Fixes:" tag

Signed-off-by: Kefu Chai <kchai@redhat.com>
---

diff --git a/SubmittingPatches.rst b/SubmittingPatches.rst
index aa0013c4e924..799b99ce14d9 100644
--- a/SubmittingPatches.rst
+++ b/SubmittingPatches.rst
@@ -376,7 +376,16 @@ the convenience of the 'pull request' feature.
    probably didn't even receive earlier versions of the patch.
 
    If the patch fixes a logged bug entry, refer to that bug entry by
-   number and URL.
+   number and URL. In particular, if this patch fixes one or more issues
+   tracked by http://tracker.ceph.com, consider adding a ``Fixes:`` tag to
+   connect this change to addressed issue(s). So a line saying ::
+
+     Fixes: #12345
+
+   is added before the ``Signed-off-by:`` line stating that this commit
+   addresses http://tracker.ceph.com/issues/12345. It helps the reviewer to
+   get more context of this bug, so she/he can hence update the issue on
+   the bug tracker accordingly.
 
 
 4. Separate your changes.