From fd91744bd427affb963c3e852f472632c4703ae1 Mon Sep 17 00:00:00 2001 From: Frank Binns Date: Tue, 28 Jul 2020 17:54:05 +0100 Subject: [PATCH] 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 Reviewed-by: Emil Velikov Part-of: --- docs/submittingpatches.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/submittingpatches.rst b/docs/submittingpatches.rst index 5c9567f..712adfc 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:: -- 2.7.4