Re: Duplicated ABI entries - Was: Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output

2020-11-15 Thread Jonathan Cameron
On Tue, 10 Nov 2020 08:26:58 +0100
Mauro Carvalho Chehab  wrote:

> Hi Jonathan,
> 
> Em Sun, 8 Nov 2020 16:56:21 +
> Jonathan Cameron  escreveu:
> 
> > > PS.: the IIO subsystem is the one that currently has more duplicated
> > > ABI entries:  
> > > $ ./scripts/get_abi.pl validate 2>&1|grep iio
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 
> > > 2 times:  Documentation/ABI/testing/sysfs-bus-iio-icm42600:0  
> > > Documentation/ABI/testing/sysfs-bus-iio:394
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 
> > > 2 times:  Documentation/ABI/testing/sysfs-bus-iio-icm42600:1  
> > > Documentation/ABI/testing/sysfs-bus-iio:395
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 
> > > 2 times:  Documentation/ABI/testing/sysfs-bus-iio-icm42600:2  
> > > Documentation/ABI/testing/sysfs-bus-iio:396
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is 
> > > defined 2 times:  Documentation/ABI/testing/sysfs-bus-iio-icm42600:3  
> > > Documentation/ABI/testing/sysfs-bus-iio:397
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is 
> > > defined 2 times:  Documentation/ABI/testing/sysfs-bus-iio-icm42600:4  
> > > Documentation/ABI/testing/sysfs-bus-iio:398
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is 
> > > defined 2 times:  Documentation/ABI/testing/sysfs-bus-iio-icm42600:5  
> > > Documentation/ABI/testing/sysfs-bus-iio:399
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 
> > > times:  Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100  
> > > Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
> > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is 
> > > defined 2 times:  Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 
> > >  Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14
> > > Warning: 
> > > /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is 
> > > defined 3 times:  
> > > Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2  
> > > Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111  
> > > Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is 
> > > defined 2 times:  
> > > Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0  
> > > Documentation/ABI/testing/sysfs-bus-iio:599
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is 
> > > defined 2 times:  
> > > Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36  
> > > Documentation/ABI/testing/sysfs-bus-iio:588
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 
> > > times:  Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43  
> > > Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
> > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is 
> > > defined 2 times:  
> > > Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0  
> > > Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> > > Warning: 
> > > /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is 
> > > defined 2 times:  
> > > Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1  
> > > Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> > > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 
> > > times:  Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0  
> > > Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
> > > Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 
> > > times:  Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92  
> > > Documentation/ABI/testing/sysfs-bus-iio:45
> 
> > 
> > That was intentional.  Often these provide more information on the
> > ABI for a particular device than is present in the base ABI doc.  
> 
> FYI, right now, there are 20 duplicated entries, being 16 of them
> from IIO, on those files:
> 
>   $ ./scripts/get_abi.pl validate 2>&1|perl -ne 'if 
> (m,(Documentation/\S+)\:,g) { print "$1\n" }'|sort|uniq
>   Documentation/ABI/stable/sysfs-driver-w1_ds28e04
>   Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8
>   Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
>   Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371
>   Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010
>   Documentation/ABI/testing/sysfs-bus-iio-icm42600
>   Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als
>   Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
>   Documentation/ABI/testing/sysfs-class-backlight-adp8860
>   Documentation/ABI/testing/sysfs-class-led-trigger-pattern
>   Documentation/ABI/testing/sysfs-kernel-iommu_groups
> 
> > 
> > A bit like when we have additional description for dt binding properties
> > for a particular device, even 

Re: Duplicated ABI entries - Was: Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output

2020-11-10 Thread Randy Dunlap
On 11/9/20 11:26 PM, Mauro Carvalho Chehab wrote:
> Hi Jonathan,
> 
> Let's view ABI from the PoV of a system admin that doesn't know
> yet about a certain ABI symbol.
> 
> He'll try to seek for the symbol, more likely using the HTML 
> documentation. Only very senior system admins might try to take
> a look at the Kernel.

FWIW, I think that the likely search methods are $search_engine
and 'grep'.

Have a good few days off.

-- 
~Randy