Re: linux-next: Fixes tag needs some work in the clk tree

From: Michael Ellerman
Date: Fri Jan 18 2019 - 07:41:47 EST


Stephen Boyd <sboyd@xxxxxxxxxx> writes:

> Quoting Fabio Estevam (2019-01-16 17:25:21)
>> On Wed, Jan 16, 2019 at 10:44 PM Stephen Boyd <sboyd@xxxxxxxxxx> wrote:
>>
>> > Ok sure. Does this matter to scripts? Is it documented in
>> > Documentation/process/submitting-patches.rst? I've seen both types, one
>>
>> From Documentation/process/submitting-patches.rst"
>>
>> "If your patch fixes a bug in a specific commit, e.g. you found an issue using
>> ``git bisect``, please use the 'Fixes:' tag with the first 12 characters of
>> the SHA-1 ID, and the one line summary. For example::
>>
>> Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()")"
>
> Yes but 'one line summary' is not clear to me. Does it mean the summary
> line? Or the one line summary on one line regardless of commit message
> column wrapping? Sorry to be pedantic but I can see how this can be
> misunderstood.

Yeah "one line summary" is referring to the subject of the commit.

So it doesn't explicitly say not to split it across lines, it probably
should.

eg: ?

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 30dc00a364e8..12a283ba3929 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -186,6 +186,8 @@ If your patch fixes a bug in a specific commit, e.g. you found an issue using

Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()")

+To ease parsing of the 'Fixes:' tag please don't split it across multiple lines.
+
The following ``git config`` settings can be used to add a pretty format for
outputting the above style in the ``git log`` or ``git show`` commands::



cheers