RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-03 01:22:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: amend Fixes instructions in SubmittingPatches

Browse Source 
Since the "Fixes: #..." line is interpreted by GitHub as referring to a
pull request, yet the intention is for it to refer to the tracker issue,
change our instructions to use the full tracker issue URL.

Now that github pull request numbers are in the 8000s, there are cases when
a PR is wrongly closed by a "Fixes: #..." line in a commit message. See

https://github.com/ceph/ceph/pull/8286#event-603120191

for one such case.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
This commit is contained in:
Nathan Cutler 2016-03-25 17:34:47 +01:00
parent 1ac8b5f972
commit 65770059cb
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
SubmittingPatches.rst
View File

@ -405,7 +405,7 @@ feature.
tracked by http://tracker.ceph.com, consider adding a ``Fixes:`` tag to tracked by http://tracker.ceph.com, consider adding a ``Fixes:`` tag to
connect this change to addressed issue(s). So a line saying :: connect this change to addressed issue(s). So a line saying ::
Fixes: #12345 Fixes: http://tracker.ceph.com/issues/12345
is added before the ``Signed-off-by:`` line stating that this commit is added before the ``Signed-off-by:`` line stating that this commit
addresses http://tracker.ceph.com/issues/12345. It helps the reviewer to addresses http://tracker.ceph.com/issues/12345. It helps the reviewer to
@ -419,7 +419,7 @@ feature.
* update the man page for bar with the newly added "--foo" option. * update the man page for bar with the newly added "--foo" option.
* fix a typo * fix a typo
Fixes: #12345 Fixes: http://tracker.ceph.com/issues/12345
Signed-off-by: Random J Developer <random@developer.example.org> Signed-off-by: Random J Developer <random@developer.example.org>
4. Separate your changes. 4. Separate your changes.