doc: split up SubmittingPatches.rst#30705
Conversation
22c9334 to
a531eb1
Compare
liewegas
left a comment
There was a problem hiding this comment.
I saw one typo; otherwise this is fantastic!
a531eb1 to
db5c8b7
Compare
|
@liewegas Thanks for the review. The typo should be fixed now, and I also pushed a second commit which adds a "Test your changes" section to |
| For example:: | ||
|
|
||
| osd: make the ClassHandler::mutex private | ||
| Fixes: 9dbe7a003989f8bb45fe14aaa587e9d60a392727 |
There was a problem hiding this comment.
I don't we have ever practised this, at least not in the main repo. Not saying that this is a bad idea, just that it doesn't codify existing practice and should be discussed on the mailing list first for it to get any traction. Because everyone is doing their own thing: I noticed @batrick has been using Introduced-by, I usually put an abbreviated SHA1 along with the title somewhere in the commit message, etc.
There was a problem hiding this comment.
We recently started making a point of mentioning the commit that introduced the problem to help identify follow-on fixes to backport, but I don't think we standardized on the Prefix: that precedes it. Fixes: seems appropriate though? In any case, this is a good time to go ahead codify this!
There was a problem hiding this comment.
@idryomov This format was suggested by Sage quite some months (or even a year or more) ago.
There was a problem hiding this comment.
I'm down with this format.
2b2d938 to
3a0da5d
Compare
|
@idryomov Thanks for the review. I think I have addressed all the comments. |
gregsfortytwo
left a comment
There was a problem hiding this comment.
Reviewed-by: Greg Farnum gfarnum@redhat.com
tchaikov
left a comment
There was a problem hiding this comment.
LGTM apart from some nits.
LenzGr
left a comment
There was a problem hiding this comment.
Apart from some minor things that I commented on, this is a great improvement. Thanks a lot!
Split the existing SubmittingPatches.rst into three files: * SubmittingPatches.rst (general guidelines, for GitHub/master branch) * SubmittingPatches-kernel.rst (for kernel patches) * SubmittingPatches-backports.rst (for backports) Fixes: http://tracker.ceph.com/issues/20953 Signed-off-by: Nathan Cutler <ncutler@suse.com>
55ed784 to
ec6af09
Compare
dadbe1f to
ec6af09
Compare
|
Thanks everyone for reviewing. There is still a lot that can be improved. I'm in the process of making further revisions - especially to |
After putting all the reviewers through ceph#30705 I realized there is still much to be improved in this document. Signed-off-by: Nathan Cutler <ncutler@suse.com>
After putting all the reviewers through ceph#30705 I realized there is still much to be improved in this document. Signed-off-by: Nathan Cutler <ncutler@suse.com>
After putting all the reviewers through ceph#30705 I realized there is still much to be improved in this document. Signed-off-by: Nathan Cutler <ncutler@suse.com>
(#22876 was too cluttered, so I replaced it with this fresh PR)
Split the existing SubmittingPatches.rst into three files:
SubmittingPatches.rst(general guidelines, for GitHub/master branch)SubmittingPatches-kernel.rst(for kernel patches)SubmittingPatches-backports.rst(for backports)Fixes: http://tracker.ceph.com/issues/20953
TODO: