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

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

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 422 bytes --]

Hi all,

In commit

  e94f43ea200a ("docs: automarkup.py: Fix invalid HTML link output and broken URI fragments")

Fixes tag

  Fixes: d18b01789ae5 ("docs: Add automatic cross-reference for

has these problem(s):

  - Subject has leading but no trailing parentheses
  - Subject has leading but no trailing quotes

Please do not split Fixes tags across more than one line.

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

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

[James Clark]

On 06/01/2022 23:36, Stephen Rothwell wrote:
> Hi all,
> 
> In commit
> 
>   e94f43ea200a ("docs: automarkup.py: Fix invalid HTML link output and broken URI fragments")
> 
> Fixes tag
> 
>   Fixes: d18b01789ae5 ("docs: Add automatic cross-reference for
> 
> has these problem(s):
> 
>   - Subject has leading but no trailing parentheses
>   - Subject has leading but no trailing quotes

Hi Stephen,

Which validator are you using for this output? checkpatch.pl has a validator for commit references
and it actually complains _more_ if it's not wrapped at 75 chars. At least for ones in the
body of the commit rather than the fixes reference. Which is a bit confusing if there is
a difference in the rule.

> 
> Please do not split Fixes tags across more than one line.
> 

Is this just for the fixes tag and not for the one in the body? Would you consider adding
this check to checkpatch.pl and submitting-patches.rst as I don't see that rule mentioned there.

@Jonathan, I'm happy to resubmit with the changes, but it might be easier if you just
make the fix in place.

Thanks
James

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

[Randy Dunlap]

Hi James,

First of all, don't always believe what checkpatch says.
Just take it as a hint.

On 1/7/22 02:25, James Clark wrote:
> 
> 
> On 06/01/2022 23:36, Stephen Rothwell wrote:
>> Hi all,
>>
>> In commit
>>
>>   e94f43ea200a ("docs: automarkup.py: Fix invalid HTML link output and broken URI fragments")
>>
>> Fixes tag
>>
>>   Fixes: d18b01789ae5 ("docs: Add automatic cross-reference for
>>
>> has these problem(s):
>>
>>   - Subject has leading but no trailing parentheses
>>   - Subject has leading but no trailing quotes
> 
> Hi Stephen,
> 
> Which validator are you using for this output? checkpatch.pl has a validator for commit references
> and it actually complains _more_ if it's not wrapped at 75 chars. At least for ones in the
> body of the commit rather than the fixes reference. Which is a bit confusing if there is
> a difference in the rule.
> 
>>
>> Please do not split Fixes tags across more than one line.
>>
> 
> Is this just for the fixes tag and not for the one in the body? Would you consider adding
> this check to checkpatch.pl and submitting-patches.rst as I don't see that rule mentioned there.

submitting-patches.rst says:

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.  Do not split the tag across multiple
lines, tags are exempt from the "wrap at 75 columns" rule in order to simplify
parsing scripts.  For example::

	Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")


Yes, checkpatch warns about that. Just ignore it.

> @Jonathan, I'm happy to resubmit with the changes, but it might be easier if you just
> make the fix in place.
> 
> Thanks
> James

-- 
~Randy

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

[Jonathan Corbet]

James Clark <james.clark@arm.com> writes:

> On 06/01/2022 23:36, Stephen Rothwell wrote:
>> Hi all,
>> 
>> In commit
>> 
>>   e94f43ea200a ("docs: automarkup.py: Fix invalid HTML link output and broken URI fragments")
>> 
>> Fixes tag
>> 
>>   Fixes: d18b01789ae5 ("docs: Add automatic cross-reference for
>> 
>> has these problem(s):
>> 
>>   - Subject has leading but no trailing parentheses
>>   - Subject has leading but no trailing quotes

[...]

> @Jonathan, I'm happy to resubmit with the changes, but it might be
> easier if you just make the fix in place.

I've fixed it, no worries.

Thanks,

jon

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

[James Clark]

On 07/01/2022 16:19, Randy Dunlap wrote:
> Hi James,
> 
> First of all, don't always believe what checkpatch says.
> Just take it as a hint.
> 
> On 1/7/22 02:25, James Clark wrote:
>>
>>
>> On 06/01/2022 23:36, Stephen Rothwell wrote:
>>> Hi all,
>>>
>>> In commit
>>>
>>>   e94f43ea200a ("docs: automarkup.py: Fix invalid HTML link output and broken URI fragments")
>>>
>>> Fixes tag
>>>
>>>   Fixes: d18b01789ae5 ("docs: Add automatic cross-reference for
>>>
>>> has these problem(s):
>>>
>>>   - Subject has leading but no trailing parentheses
>>>   - Subject has leading but no trailing quotes
>>
>> Hi Stephen,
>>
>> Which validator are you using for this output? checkpatch.pl has a validator for commit references
>> and it actually complains _more_ if it's not wrapped at 75 chars. At least for ones in the
>> body of the commit rather than the fixes reference. Which is a bit confusing if there is
>> a difference in the rule.
>>
>>>
>>> Please do not split Fixes tags across more than one line.
>>>
>>
>> Is this just for the fixes tag and not for the one in the body? Would you consider adding
>> this check to checkpatch.pl and submitting-patches.rst as I don't see that rule mentioned there.
> 
> submitting-patches.rst says:
> 
> 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.  Do not split the tag across multiple
> lines, tags are exempt from the "wrap at 75 columns" rule in order to simplify
> parsing scripts.  For example::

Thanks I missed that bit.
> 
> 	Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
> 
> 
> Yes, checkpatch warns about that. Just ignore it.

I looked into adding a line break warning in checkpatch for 'Fixes:' but it's not easy because it seems like
the fixes field is more permissive than the other one:

	o Fixes: style doesn't require ("<commit_description>")
	parentheses and double quotes like other uses of
	git commit ID and description.

> 
>> @Jonathan, I'm happy to resubmit with the changes, but it might be easier if you just
>> make the fix in place.
>>
>> Thanks
>> James
> 

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

[Jonathan Corbet]

Stephen Rothwell <sfr@canb.auug.org.au> writes:

> Hi all,
>
> In commit
>
>   c029b8a0c5d0 ("Fix documentation of panic_on_warn")
>
> Fixes tag
>
>   Fixes: 9e3961a0978 ("kernel: add panic_on_warn")
>
> has these problem(s):
>
>   - Target SHA1 does not exist
>
> Maybe you meant
>
> Fixes: 9e3961a09798 ("kernel: add panic_on_warn")

Apologies...I'll get this right one of these years...

Should be good now, thanks.

jon

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

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 311 bytes --]

Hi all,

In commit

  c029b8a0c5d0 ("Fix documentation of panic_on_warn")

Fixes tag

  Fixes: 9e3961a0978 ("kernel: add panic_on_warn")

has these problem(s):

  - Target SHA1 does not exist

Maybe you meant

Fixes: 9e3961a09798 ("kernel: add panic_on_warn")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

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

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 514 bytes --]

Hi all,

In commit

  54179768c2e6 ("Fix documentation of panic_on_warn")

Fixes tag

  Fixes: 9e3961a097 ("kernel: add panic_on_warn")

has these problem(s):

  - SHA1 should be at least 12 digits long
    This can be fixed for the future by setting core.abbrev to 12 (or
    more) or (for git v2.11 or later) just making sure it is not set
    (or set to "auto").

Also, please keep all the commit message tag lines together at the end
of the commit message.

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

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

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 456 bytes --]

Hi all,

In commit

  e0ced88d6439 ("Documentation: kunit: Fix cross-referencing warnings")

Fixes tag

  Fixes: bc145b370c ("Documentation: KUnit: Added KUnit Architecture")

has these problem(s):

  - SHA1 should be at least 12 digits long
    This can be fixed for the futreu by setting core.abbrev to 12 (or
    more) or (for git v2.11 or later) just making sure it is not set
    (or set to "auto").`

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

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

[Andrew Donnellan]

On 26/2/21 8:39 am, Jonathan Corbet wrote:
> Stephen Rothwell <sfr@canb.auug.org.au> writes:
> 
>> Hi all,
>>
>> In commit
>>
>>    36eaf08fc283 ("docs: powerpc: Fix tables in syscall64-abi.rst")
>>
>> Fixes tag
>>
>>    Fixes: 209b44c804c ("docs: powerpc: syscall64-abi.rst: fix a malformed table")
>>
>> has these problem(s):
>>
>>    - SHA1 should be at least 12 digits long
>>
>> I don't think this is worth rebasing for, but in the future it can be
>> fixed by setting core.abbrev to 12 (or more) or (for git v2.11 or later)
>> just making sure it is not set (or set to "auto").
> 
> I made that tag by hand while "fixing" the changlog on that commit,
> which included the full ID.  Obviously, counting to 12 is a challenging
> task for a slow guy like me...:)

No, no, my local tree tells me that *I* made that tag by hand and failed 
to count properly... sorry for the noise!

-- 
Andrew Donnellan              OzLabs, ADL Canberra
ajd@linux.ibm.com             IBM Australia Limited

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

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 414 bytes --]

Hi Jon,

On Thu, 25 Feb 2021 14:39:33 -0700 Jonathan Corbet <corbet@lwn.net> wrote:
>
> I made that tag by hand while "fixing" the changlog on that commit,
> which included the full ID.  Obviously, counting to 12 is a challenging
> task for a slow guy like me...:)

Which is why I have a script called clog:

!/bin/bash

git log -1 --format='  %h ("%s")' "$@"

:-)

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

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

[Jonathan Corbet]

Stephen Rothwell <sfr@canb.auug.org.au> writes:

> Hi all,
>
> In commit
>
>   36eaf08fc283 ("docs: powerpc: Fix tables in syscall64-abi.rst")
>
> Fixes tag
>
>   Fixes: 209b44c804c ("docs: powerpc: syscall64-abi.rst: fix a malformed table")
>
> has these problem(s):
>
>   - SHA1 should be at least 12 digits long
>
> I don't think this is worth rebasing for, but in the future it can be
> fixed by setting core.abbrev to 12 (or more) or (for git v2.11 or later)
> just making sure it is not set (or set to "auto").

I made that tag by hand while "fixing" the changlog on that commit,
which included the full ID.  Obviously, counting to 12 is a challenging
task for a slow guy like me...:)

Thanks,

jon

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

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 492 bytes --]

Hi all,

In commit

  36eaf08fc283 ("docs: powerpc: Fix tables in syscall64-abi.rst")

Fixes tag

  Fixes: 209b44c804c ("docs: powerpc: syscall64-abi.rst: fix a malformed table")

has these problem(s):

  - SHA1 should be at least 12 digits long

I don't think this is worth rebasing for, but in the future it can be
fixed by setting core.abbrev to 12 (or more) or (for git v2.11 or later)
just making sure it is not set (or set to "auto").

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

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

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 323 bytes --]

Hi all,

In commit

  cf9cadf16b19 ("docs/admin-guide: cgroup-v2: typos and spaces")

Fixes tag

  Fixes: 5f9a4f4a70960

has these problem(s):

  - missing subject

Maybe you meant

Fixes: 5f9a4f4a7096 ("mm: memcontrol: add the missing numa_stat interface for cgroup v2")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

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

[Sven Eckelmann]

[-- Attachment #1: Type: text/plain, Size: 396 bytes --]

On Tuesday, 21 May 2019 21:04:31 CEST Jonathan Corbet wrote:
> It was just a sigh because there was a little mess that I needed to clean
> up — one that I had failed to clean up correctly on my first attempt.
> That's all. Apologies for giving you any other sort of impression, that
> was not intended.  Things happen, life goes on.

Ok. Thanks for cleaning it up.

Kind regards,
	Sven

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Jonathan Corbet]

On Tue, 21 May 2019 20:52:46 +0200
Sven Eckelmann <sven@narfation.org> wrote:

> > I'm hoping that's meant to be a joke...?  This is certainly not a big
> > problem on any scale...  
> 
> Not really. If you are so frustrated that you start your reply with "<sigh>" 
> then I think that it was not enough for me to explain what I did wrong and 
> that I am sorry about copying the wrong git commit + not noticing it when 
> pasting it to the commit message. What else should I do? Jump back in time?

It was just a sigh because there was a little mess that I needed to clean
up — one that I had failed to clean up correctly on my first attempt.
That's all. Apologies for giving you any other sort of impression, that
was not intended.  Things happen, life goes on.

jon

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

[Sven Eckelmann]

[-- Attachment #1: Type: text/plain, Size: 646 bytes --]

On Tuesday, 21 May 2019 20:46:03 CEST Jonathan Corbet wrote:
> On Tue, 21 May 2019 20:23:48 +0200
> Sven Eckelmann <sven@narfation.org> wrote:
> 
> > > <sigh>  
> > 
> > It is ok, I will never send you any patch again.
> 
> I'm hoping that's meant to be a joke...?  This is certainly not a big
> problem on any scale...

Not really. If you are so frustrated that you start your reply with "<sigh>" 
then I think that it was not enough for me to explain what I did wrong and 
that I am sorry about copying the wrong git commit + not noticing it when 
pasting it to the commit message. What else should I do? Jump back in time?

Kind regards,
	Sven

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Jonathan Corbet]

On Tue, 21 May 2019 20:23:48 +0200
Sven Eckelmann <sven@narfation.org> wrote:

> > <sigh>  
> 
> It is ok, I will never send you any patch again.

I'm hoping that's meant to be a joke...?  This is certainly not a big
problem on any scale...

jon

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

[Sven Eckelmann]

[-- Attachment #1: Type: text/plain, Size: 261 bytes --]

On Tuesday, 21 May 2019 17:31:07 CEST Jonathan Corbet wrote:
> <sigh>

It is ok, I will never send you any patch again.

> We want those tags to be right.  I'm going to fix this and force-push,
> hopefully nobody will get too made at me...

Kind regards,
	Sven

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Jonathan Corbet]

On Tue, 21 May 2019 09:18:21 +0200
Sven Eckelmann <sven@narfation.org> wrote:

> On Monday, 20 May 2019 23:54:23 CEST Jonathan Corbet wrote:
> [...]
> > Argh, sorry, I should have caught that.  Fixed, thanks.  
> 
> Thanks for trying. Unfortunately it was changed to the wrong value. The actual 
> commit I wanted to reference in both places of the commit message was:
> 
>     8ea8814fcdcb ("LICENSES: Clearly mark dual license only licenses")
> 
> It seems I've copied the wrong commit id for some reason when I send it though 
> the git-fixes alias and it didn't occur to me that I just referenced my own 
> patch. Sorry about the confusion.

<sigh>

We want those tags to be right.  I'm going to fix this and force-push,
hopefully nobody will get too made at me...

jon

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

[Sven Eckelmann]

[-- Attachment #1: Type: text/plain, Size: 560 bytes --]

On Monday, 20 May 2019 23:54:23 CEST Jonathan Corbet wrote:
[...]
> Argh, sorry, I should have caught that.  Fixed, thanks.

Thanks for trying. Unfortunately it was changed to the wrong value. The actual 
commit I wanted to reference in both places of the commit message was:

    8ea8814fcdcb ("LICENSES: Clearly mark dual license only licenses")

It seems I've copied the wrong commit id for some reason when I send it though 
the git-fixes alias and it didn't occur to me that I just referenced my own 
patch. Sorry about the confusion.

Kind regards,
	Sven

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Sven Eckelmann]

[-- Attachment #1: Type: text/plain, Size: 471 bytes --]

On Monday, 20 May 2019 23:44:35 CEST Stephen Rothwell wrote:
> Hi all,
> 
> In commit
> 
>   9eaa65e8aad5 ("scripts/spdxcheck.py: Add dual license subdirectory")
> 
> Fixes tag
> 
>   Fixes: 99871f2f9a4d ("scripts/spdxcheck.py: Fix path to deprecated licenses")
[...]

Sorry, my fault. I actually meant 8ea8814fcdcb ("LICENSES: Clearly mark dual 
license only licenses") at both places in the commit message.

Anything which can be done from my site?

Kind regards,
	Sven

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Jonathan Corbet]

On Tue, 21 May 2019 07:44:35 +1000
Stephen Rothwell <sfr@canb.auug.org.au> wrote:

> In commit
> 
>   9eaa65e8aad5 ("scripts/spdxcheck.py: Add dual license subdirectory")
> 
> Fixes tag
> 
>   Fixes: 99871f2f9a4d ("scripts/spdxcheck.py: Fix path to deprecated licenses")
> 
> has these problem(s):
> 
>   - Target SHA1 does not exist
> 
> Did you mean
> 
> Fixes: e6d319f68d4d ("scripts/spdxcheck.py: Fix path to deprecated licenses")

Argh, sorry, I should have caught that.  Fixed, thanks.

jon

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

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 382 bytes --]

Hi all,

In commit

  9eaa65e8aad5 ("scripts/spdxcheck.py: Add dual license subdirectory")

Fixes tag

  Fixes: 99871f2f9a4d ("scripts/spdxcheck.py: Fix path to deprecated licenses")

has these problem(s):

  - Target SHA1 does not exist

Did you mean

Fixes: e6d319f68d4d ("scripts/spdxcheck.py: Fix path to deprecated licenses")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]