docs: change "Fixes:" tag example to match git fixes output
authorFrank Binns <frank.binns@imgtec.com>
Tue, 28 Jul 2020 16:54:05 +0000 (17:54 +0100)
committerMarge Bot <eric+marge@anholt.net>
Wed, 29 Jul 2020 15:25:24 +0000 (15:25 +0000)
The "Fixes:" tag example has the commit title in double quotes, whereas the
suggested git fixes alias, a couple of lines below, also adds some outer
parenthesis.

Although there doesn't appear to be a consistent format for the "Fixes:" tag,
other than it should be a git commit sha followed by the commit title, the
information in the docs should at least be consistent. As the "Fixes:" tag was
inspired by the Linux kernel, which does have parenthesis, update the example to
match the git fixes output.

Signed-off-by: Frank Binns <frank.binns@imgtec.com>
Reviewed-by: Emil Velikov <emil.velikov@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6106>

docs/submittingpatches.rst

index 5c9567f87693277983c5323c7db466994428646a..712adfc5c9b799e2cd1e2026049dbdb155542c35 100644 (file)
@@ -112,7 +112,7 @@ The ``Fixes:`` tag
 If a patch addresses a issue introduced with earlier commit, that
 should be noted in the commit message. For example::
 
-    Fixes: d7b3707c612 "util/disk_cache: use stat() to check if entry is a directory"
+    Fixes: d7b3707c612 ("util/disk_cache: use stat() to check if entry is a directory")
 
 You can produce those fixes lines by running this command once::