From: Kefu Chai Date: Wed, 20 Jan 2016 08:54:57 +0000 (+0800) Subject: SubmittingPatches: add doc for commit title X-Git-Tag: v10.0.4~189^2~2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=18409a897b9bfb7c47df2795c7db4a807a676e9a;p=ceph.git SubmittingPatches: add doc for commit title explain that we need a prefix in the commit title Signed-off-by: Kefu Chai --- diff --git a/SubmittingPatches.rst b/SubmittingPatches.rst index 799b99ce14d9..27f04f786945 100644 --- a/SubmittingPatches.rst +++ b/SubmittingPatches.rst @@ -355,6 +355,16 @@ the convenience of the 'pull request' feature. Describe the technical detail of the change(s) your patch includes. + The text up to the first empty line in a commit message is the commit + title. Ideally it is a single short line less than 50 characters, + summarizing the change. It is required to prefix it with the + subsystem or module you are changing. For instance, the prefix + could be "doc:", "osd:", or "common:". One can use:: + + git log + + for more examples. + Be as specific as possible. The WORST descriptions possible include things like "update driver X", "bug fix for driver X", or "this patch includes updates for subsystem X. Please apply." @@ -387,6 +397,15 @@ the convenience of the 'pull request' feature. get more context of this bug, so she/he can hence update the issue on the bug tracker accordingly. + So a typical commit message for revising the document could look like:: + + doc: add "--foo" option to bar + + * update the man page for bar with the newly added "--foo" option. + * fix a typo + + Fixes: #12345 + Signed-off-by: Random J Developer 4. Separate your changes.