]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
SubmittingPatches: add doc for "Fixes:" tag
authorKefu Chai <kchai@redhat.com>
Wed, 20 Jan 2016 08:23:04 +0000 (16:23 +0800)
committerKefu Chai <kchai@redhat.com>
Thu, 21 Jan 2016 04:27:54 +0000 (12:27 +0800)
Signed-off-by: Kefu Chai <kchai@redhat.com>
SubmittingPatches.rst

index aa0013c4e92493511041fa35e35a851174399144..799b99ce14d907d6a6dff69bff19efab19854d61 100644 (file)
@@ -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.