Re: [ANN] pylint and shellcheck

[Donald Hunter <donald.hunter@gmail.com>]

Jakub Kicinski <kuba@kernel.org> writes:

> On Thu, 05 Jun 2025 10:02:10 +0100 Donald Hunter wrote:
>> Jakub Kicinski <kuba@kernel.org> writes:
>> 
>> > On Wed, 04 Jun 2025 10:41:14 +0100 Donald Hunter wrote:  
>> >> This is a possible config for yamllint:
>> >> 
>> >> extends: default
>> >> rules:
>> >>   document-start: disable
>> >>   brackets:
>> >>     max-spaces-inside: 1
>> >>   comments:
>> >>     min-spaces-from-content: 1
>> >>   line-length:
>> >>     max: 96  
>> >
>> > This fits our current style pretty nicely!
>> >
>> > One concern I have is that yamllint walks down the filesystem
>> > CWD down to root or home dir. So if we put this in
>> > Documentation/netlink/.yamllint people running yamllint from main dir:
>> >
>> >  $ yamllint Documentation/netlink/specs/netdev.yaml
>> >
>> > will be given incorrect warnings, no? Is there a workaround?  
>> 
>> I don't see a workaround without some kind of wrapper.
>> 
>> Maybe just add a makefile? Looks like that was the approach taken for
>> Documentation/devicetree/bindings
>
> If we can live with the document-start annoyance I was wondering 
> if we can stick to the "default" as is? We can fix existing
> docs slowly, the patchwork script will ignore pre-existing warnings.

TBH I could go through and fix all the warnings, including adding the
document start markers. I can automate most of them with perl
one-liners. The rest would be a few minutes of editing.

I could have patches ready for the merge window opening. What's best, a
patch per type of error, or some other split?