Re: [PATCH 00/10] Fix documentation warnings at linux-next

[Jonathan Cameron <Jonathan.Cameron@Huawei.com>]

On Tue, 19 Jan 2021 18:17:05 +0900
William Breathitt Gray <vilhelm.gray@gmail.com> wrote:

> On Sun, Jan 17, 2021 at 03:42:18PM +0000, Jonathan Cameron wrote:
> > On Fri, 15 Jan 2021 13:47:20 +0000
> > Jonathan Cameron <Jonathan.Cameron@Huawei.com> wrote:
> >   
> > > On Fri, 15 Jan 2021 10:49:47 +0100
> > > Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> > >   
> > > > Hi Lukas,
> > > > 
> > > > Em Fri, 15 Jan 2021 07:12:38 +0100
> > > > Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu:
> > > >     
> > > > > [reduced the recipient list to the main responsible ones and list]
> > > > > 
> > > > > Hi Mauro, hi Jonathan,
> > > > > 
> > > > > We both, Mauro and I, have been submitting patches to address the
> > > > > documentation warnings on linux-next. If it is okay with you, Mauro, I
> > > > > would like to take responsibility for the task to send out the patches
> > > > > to address all warnings on linux-next in make htmldocs and follow up
> > > > > with all the discussions. I can also provide a short weekly summary
> > > > > (probably always on Friday) on what is pending where and what I could
> > > > > not resolve by myself.
> > > > > 
> > > > > Is that okay for you?
> > > > > 
> > > > > If at some point I do not have the time to take care anymore, I will
> > > > > let you know.      
> > > > 
> > > > Yeah, sure!
> > > > 
> > > > Anyway, after applying the patches I sent this week, the warnings
> > > > I'm getting are all due to the validation scripts I wrote. So, if 
> > > > everything gets merged (either yours or my version), we'll have zero
> > > > Sphinx/kernel-doc warnings again.
> > > > 
> > > > The script-validation warnings are:
> > > > 
> > > > 1. Broken cross references
> > > > --------------------------
> > > > 
> > > > $ scripts/documentation-file-ref-check
> > > > Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> > > > Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > > > Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > > > Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt
> > > > Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml
> > > > Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst
> > > > Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml
> > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml
> > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml
> > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml
> > > > Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > > > Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst
> > > > 
> > > > It sounds that part of the above is due to DT patches that weren't
> > > > merged yet, but there are a few others that can be solved, but may
> > > > require discussions with some Kernel developers/maintainers.
> > > > 
> > > > 2. Duplicated ABI definitions
> > > > -----------------------------
> > > > 
> > > > $ scripts/get_abi.pl validate
> > > > 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_count_quadrature_mode_available is defined 2 times:  ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2  ./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
> > > > Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times:  ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12  ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4
> > > > Warning: /sys/class/leds/<led>/repeat is defined 2 times:  ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28  ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0
> > > > Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times:  ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15  ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27
> > > > 
> > > > Perhaps you could check with Jonathan Cameron some strategy to address
> > > > the IIO warnings.    
> > > 
> > > I'm being a bit rubbish on those ones. All need a bit of thought...
> > > 
> > > I'll try to kill off a few of them this weekend as *touch wood* my
> > > review queue is looking fairly short.  
> > 
> > As I mentioned in the cover letter for the series I've just sent out, I ran into
> > a bit of an understanding gap around the two counter cases.  This isn't helped
> > by the fact it is at least partly deprecated ABI given the counter subsystem
> > has much richer ABI for these types of devices.
> > 
> > @Fabrice, Benjamin and William.
> > What do we do about that one?
> > 
> > Thanks,
> > 
> > Jonathan  
> 
> I'd consider the IIO counter ABI as entirely deprecated -- the Counter
> subsystem supports all the functionality that's provided by the IIO
> counter ABI, as well as additional functionality that is missing. 
> 
> Regarding the iio:deviceX/in_count_quadrature_mode_available attribute:
> superseded by the Counter subsystem counterX/countY/function attribute.
> The IIO counter ABI allows users to select between a quadrature counting
> mode or a non-quadrature counting mode; unfortunately, it does not
> specify what kind of quadrature or what kind of non-quadrature counting
> is actually being performed by the device.
> 
> Because the 104-quad-8 and stm32-lptimer-cnt drivers were the only ones
> to use this attribute, they are luckily in sync -- both define the same
> possible modes available: "quadrature" and "non-quadrature". You could
> simply consolidate this attribute to the main sys-bus-iio file in order
> to resolve this warning.
> 
> Given that it has already been superceded by the Counter subsystem, I'd
> also be all right with just removing the IIO Counter ABI entirely from
> the codebase, or alternatively setting a future date for removal.

I agree that we should look to remove this ABI.  If we can establish no one
is relying on it today then we can drop quickly.  If not it would be good
to establish when we drop it.

Fabrice, Benjami any thoughts on the stm32-lptimer-cnt?

I'm going to hazard a guess that there aren't many 104-quad-8 users
that you don't know about William, so if you think we can immediately drop
the interface from that, lets do so, whether or not we can clean up
the stm32 one at the same time.

Jonathan

> 
> William Breathitt Gray
> 
> > > 
> > > Jonathan
> > >   
> > > > 
> > > > Thanks,
> > > > Mauro    
> > >   
> >   
>