Regarding undocumented string checkpatch.pl warning

Regarding undocumented string checkpatch.pl warning

[Debleena Sen]

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

I came across the following warning in drivers/staging/wilc1000/wilc_spi.c

WARNING: DT compatible string "microchip,wilc1000-spi" appears
un-documented --check ./Documentation/devicetree/bindings/

I referred to  ./Documentation/devicetree/bindings/  and checked /staging,
resource-names.txt, vendor-prefixes.txt but I could not find anything
related to microchip or wilc1000.

On referring to ./Documentation/devicetree/bindings/spi  I found a text
file "microchip,spi-pic32.txt"  but I do not think its related to WILC1000
driver.

What should I do to remove this warning?

[-- Attachment #2: Type: text/html, Size: 721 bytes --]

Re: Regarding undocumented string checkpatch.pl warning

[idebleenasen]

[-- Attachment #1.1: Type: text/plain, Size: 928 bytes --]

On Tuesday, March 5, 2019 at 12:49:53 AM UTC+5:30, Debleena Sen wrote:
>
> I came across the following warning in drivers/staging/wilc1000/wilc_spi.c
>
> WARNING: DT compatible string "microchip,wilc1000-spi" appears 
> un-documented --check ./Documentation/devicetree/bindings/
>
> I referred to  ./Documentation/devicetree/bindings/  and checked /staging, 
> resource-names.txt, vendor-prefixes.txt but I could not find anything 
> related to microchip or wilc1000.
>
> On referring to ./Documentation/devicetree/bindings/spi  I found a text 
> file "microchip,spi-pic32.txt"  but I do not think its related to WILC1000 
> driver.
>
> What should I do to remove this warning? 
>

Wanted to add that I found another text file in drivers/staging/wilc1000 
itself named "microchip,wilc1000,spi.txt". I think this is the required 
file. Should I move/copy this file to ./Documentation/devicetree/bindings/ 
to remove the warning?

[-- Attachment #1.2: Type: text/html, Size: 1242 bytes --]

Re: [Outreachy kernel] Re: Regarding undocumented string checkpatch.pl warning

[Greg KH]

On Mon, Mar 04, 2019 at 11:50:35AM -0800, idebleenasen@gmail.com wrote:
> On Tuesday, March 5, 2019 at 12:49:53 AM UTC+5:30, Debleena Sen wrote:
> >
> > I came across the following warning in drivers/staging/wilc1000/wilc_spi.c
> >
> > WARNING: DT compatible string "microchip,wilc1000-spi" appears 
> > un-documented --check ./Documentation/devicetree/bindings/
> >
> > I referred to  ./Documentation/devicetree/bindings/  and checked /staging, 
> > resource-names.txt, vendor-prefixes.txt but I could not find anything 
> > related to microchip or wilc1000.
> >
> > On referring to ./Documentation/devicetree/bindings/spi  I found a text 
> > file "microchip,spi-pic32.txt"  but I do not think its related to WILC1000 
> > driver.
> >
> > What should I do to remove this warning? 
> >
> 
> Wanted to add that I found another text file in drivers/staging/wilc1000 
> itself named "microchip,wilc1000,spi.txt". I think this is the required 
> file. Should I move/copy this file to ./Documentation/devicetree/bindings/ 
> to remove the warning?

No, staging drivers are supposed to be "self contained" and not need
changes in other parts of the kernel.  That doesn't work well with DT
files, so for now, until the driver gets merged to the "correct" part of
the kernel, the DT files stay with the driver itself.

Please do not move that file, as I will not take that patch, and you can
just ignore that checkpatch warning, there's nothing to do for it at
this point in time.

hope this helps,

greg k-h

Re: [Outreachy kernel] Re: Regarding undocumented string checkpatch.pl warning

[Debleena Sen]

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

On Tue, 5 Mar 2019, 12:35 Greg KH, <greg@kroah.com> wrote:

> On Mon, Mar 04, 2019 at 11:50:35AM -0800, idebleenasen@gmail.com wrote:
> > On Tuesday, March 5, 2019 at 12:49:53 AM UTC+5:30, Debleena Sen wrote:
> > >
> > > I came across the following warning in
> drivers/staging/wilc1000/wilc_spi.c
> > >
> > > WARNING: DT compatible string "microchip,wilc1000-spi" appears
> > > un-documented --check ./Documentation/devicetree/bindings/
> > >
> > > I referred to  ./Documentation/devicetree/bindings/  and checked
> /staging,
> > > resource-names.txt, vendor-prefixes.txt but I could not find anything
> > > related to microchip or wilc1000.
> > >
> > > On referring to ./Documentation/devicetree/bindings/spi  I found a
> text
> > > file "microchip,spi-pic32.txt"  but I do not think its related to
> WILC1000
> > > driver.
> > >
> > > What should I do to remove this warning?
> > >
> >
> > Wanted to add that I found another text file in drivers/staging/wilc1000
> > itself named "microchip,wilc1000,spi.txt". I think this is the required
> > file. Should I move/copy this file to
> ./Documentation/devicetree/bindings/
> > to remove the warning?
>
> No, staging drivers are supposed to be "self contained" and not need
> changes in other parts of the kernel.  That doesn't work well with DT
> files, so for now, until the driver gets merged to the "correct" part of
> the kernel, the DT files stay with the driver itself.
>
> Please do not move that file, as I will not take that patch, and you can
> just ignore that checkpatch warning, there's nothing to do for it at
> this point in time.
>
> hope this helps,
>
> greg k-h
>

OK. Thanks!

>

[-- Attachment #2: Type: text/html, Size: 2490 bytes --]