Re: [PATCH 06/17] ABI: sysfs-bus-pci: add documentation for modalias

[Mauro Carvalho Chehab]

Em Tue, 28 Sep 2021 12:48:10 +0200
Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx> escreveu:

> On Mon, Sep 27, 2021 at 03:59:39PM +0200, Mauro Carvalho Chehab wrote:
> > Even being available since 2005, there's no documentation for
> > modalias.
> > 
> > Acked-by: Bjorn Helgaas <bhelgaas@xxxxxxxxxx>
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> > ---
> > 
> > See [PATCH 00/17] at: https://lore.kernel.org/all/cover.1632750608.git.mchehab+huawei@xxxxxxxxxx/
> > 
> >  Documentation/ABI/testing/sysfs-bus-pci | 18 ++++++++++++++++++
> >  1 file changed, 18 insertions(+)
> > 
> > diff --git a/Documentation/ABI/testing/sysfs-bus-pci b/Documentation/ABI/testing/sysfs-bus-pci
> > index 191cbe9ae5ed..1eeac7f59672 100644
> > --- a/Documentation/ABI/testing/sysfs-bus-pci
> > +++ b/Documentation/ABI/testing/sysfs-bus-pci
> > @@ -187,6 +187,24 @@ Description:
> >  		The symbolic link points to the PCI device sysfs entry of the
> >  		Physical Function this device associates with.
> >  
> > +What:		/sys/bus/pci/devices/.../modalias
> > +Date:		May 2005  
> 
> Wow, I was not good at documenting this stuff back then, sorry about
> that :(

Yeah, I guess most of the undocumented stuff comes from old times.
 
> I'll queue this series up now, thanks so much for working on this!

Anytime! I'm also glad with the results. 

-

I guess that there's still one missing feature at the script,
that should probably be easy to implement.

Right now, "./get_abi.pl search <foo>" doesn't evaluate regexes,
but searches for a substring match. This is very fast, but
we could do better, by changing the logic in order to use the
preparation part of the "undefined" logic, if the exact match
doesn't happen.

This way, a sys admin could use the script in order to find
documentation for a certain sysfs file on his system.

If I have some spare time left, I guess I'll try to implement
it.

Thanks,
Mauro