diff options
| author | Frank Binns <frank.binns@imgtec.com> | 2020-07-28 17:54:05 +0100 |
|---|---|---|
| committer | Marge Bot <eric+marge@anholt.net> | 2020-07-29 15:25:24 +0000 |
| commit | fd91744bd427affb963c3e852f472632c4703ae1 (patch) | |
| tree | 8a582ceaace3384ccb8048214839e0af49cb8509 /docs | |
| parent | aa89693c02728aee2912b5be91d23a15e319d952 (diff) | |
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>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/submittingpatches.rst | 2 |
1 files changed, 1 insertions, 1 deletions
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:: |