]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
SubmittingPatches: Improve SubmittingPatches example 46098/head
authorAnthony D'Atri <anthonyeleven@users.noreply.github.com>
Sat, 30 Apr 2022 07:56:21 +0000 (00:56 -0700)
committerAnthony D'Atri <anthonyeleven@users.noreply.github.com>
Sat, 30 Apr 2022 08:06:28 +0000 (01:06 -0700)
The example commit didn't show the convention of prefixing the message with
the relative directory path where the file lives, which has led new
contributors to innocently submit changes that aren't formatted ideally.
This adds a path to the example.

Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
SubmittingPatches.rst

index 4e01082fd9eaab28a9a85fc6d0bf48de10260725..f708b3c004f3f91ec8212853e50b8dba8028dc0a 100644 (file)
@@ -173,7 +173,7 @@ able to refer to the bug tracker easily.
 
 Here is an example showing a properly-formed commit message::
 
-     doc: add "--foo" option to bar
+     doc/rados/mumble: Add "--foo" option to bar
 
      This commit updates the man page for bar with the newly added "--foo"
      option.