SubmittingPatches: use "doc" prefix in title of doc-only commits

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/SubmittingPatches.rst b/SubmittingPatches.rst
index d74529cd3ba07ecb1c88f14161da95d073b5d792..5acb9dbdc6a48f18ab34fb91a787b9e4ea8896eb 100644 (file)
--- 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::