Mesa (master): docs: change "Fixes:" tag example to match git fixes output
GitLab Mirror
gitlab-mirror at kemper.freedesktop.org
Wed Jul 29 15:29:20 UTC 2020
Module: Mesa
Branch: master
Commit: fd91744bd427affb963c3e852f472632c4703ae1
URL: http://cgit.freedesktop.org/mesa/mesa/commit/?id=fd91744bd427affb963c3e852f472632c4703ae1
Author: Frank Binns <frank.binns at imgtec.com>
Date: Tue Jul 28 17:54:05 2020 +0100
docs: change "Fixes:" tag example to match git fixes output
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 at imgtec.com>
Reviewed-by: Emil Velikov <emil.velikov at collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6106>
---
docs/submittingpatches.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/submittingpatches.rst b/docs/submittingpatches.rst
index 5c9567f8769..712adfc5c9b 100644
--- a/docs/submittingpatches.rst
+++ b/docs/submittingpatches.rst
@@ -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::
More information about the mesa-commit
mailing list