KonstantinSeurer
/
mesa
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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@imgtec.com>
Reviewed-by: Emil Velikov <emil.velikov@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6106>
This commit is contained in:
Frank Binns 2020-07-28 17:54:05 +01:00 committed by Marge Bot
parent aa89693c02
commit fd91744bd4
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/submittingpatches.rst
View 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::