From: Kefu Chai Date: Wed, 7 Oct 2020 09:43:57 +0000 (+0800) Subject: SubmittingPatches: use "doc" prefix in title of doc-only commits X-Git-Tag: v16.1.0~900^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=38ced6048559dd5ae07ad0f517bec203e8968bb0;p=ceph.git SubmittingPatches: use "doc" prefix in title of doc-only commits Signed-off-by: Kefu Chai --- diff --git a/SubmittingPatches.rst b/SubmittingPatches.rst index d74529cd3ba0..5acb9dbdc6a4 100644 --- a/SubmittingPatches.rst +++ b/SubmittingPatches.rst @@ -122,6 +122,12 @@ imperative mood in the commit title. Positive examples include:: mds: add perf counter for finisher of MDSRank osd: make the ClassHandler::mutex private +If the change only touches the files under ``doc`` directory, the title +should start with "doc". For instance, a commit fixing a typo in +``doc/mgr/dashboard.rst`` could have a title like:: + + doc/mgr/dashboard: fix a typo + More positive examples can be obtained from the git history of the ``master`` branch::