Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output
From: Jonathan Cameron <jic23@kernel.org>
Date: 2020-11-08 16:56:42
Also in:
linux-acpi, linux-iio, linux-mm, linux-pm, linux-usb, linuxppc-dev, lkml, netdev, xen-devel
Possibly related (same subject, not in this thread)
- 2020-10-30 · Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output · Frederic Barrat <hidden>
On Mon, 2 Nov 2020 15:42:50 +0100 Mauro Carvalho Chehab [off-list ref] wrote:
Em Mon, 2 Nov 2020 13:46:41 +0100 Greg Kroah-Hartman [off-list ref] escreveu:quoted
On Mon, Nov 02, 2020 at 12:04:36PM +0100, Fabrice Gasnier wrote:quoted
On 10/30/20 11:09 AM, Mauro Carvalho Chehab wrote:quoted
Em Fri, 30 Oct 2020 10:19:12 +0100 Fabrice Gasnier [off-list ref] escreveu:quoted
Hi Mauro, [...]quoted
+What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available +KernelVersion: 4.12 +Contact: benjamin.gaignard@st.com +Description: + Reading returns the list possible quadrature modes. + +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode +KernelVersion: 4.12 +Contact: benjamin.gaignard@st.com +Description: + Configure the device counter quadrature modes: + + channel_A: + Encoder A input servers as the count input and B as + the UP/DOWN direction control input. + + channel_B: + Encoder B input serves as the count input and A as + the UP/DOWN direction control input. + + quadrature: + Encoder A and B inputs are mixed to get direction + and count with a scale of 0.25. +Hi Fabrice,quoted
I just noticed that since Jonathan question in v1. Above ABI has been moved in the past as discussed in [1]. You can take a look at: b299d00 IIO: stm32: Remove quadrature related functions from trigger driver Could you please remove the above chunk ? With that, for the stm32 part: Acked-by: Fabrice Gasnier <redacted>Hmm... probably those were re-introduced due to a rebase. This series were originally written about 1,5 years ago. I'll drop those hunks.Hi Mauro, Greg, I just figured out this patch has been applied with above hunk. This should be dropped: is there a fix on its way already ? (I may have missed it)Can you send a fix for just this hunk?Hmm... $ git grep /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available Even re-doing the changes from changeset b299d00420e2 ("IIO: stm32: Remove quadrature related functions from trigger driver") at Documentation/ABI/testing/sysfs-bus-iio-timer-stm32, there's still a third duplicate of some of those, as reported by the script: $ ./scripts/get_abi.pl validate 2>&1|grep quadra 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 As in_count_quadrature_mode_available is also defined at: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 The best here seems to have a patch that will also drop the other duplication of this, probably moving in_count_quadrature_mode_available to a generic node probably placing it inside Documentation/ABI/testing/sysfs-bus-iio.
In this particular case it may be valid to do that, but it's not in general without loosing information - see below.
Comments? Thanks, Mauro PS.: the IIO subsystem is the one that currently has more duplicated ABI entries:
That was intentional. Often these provide more information on the ABI for a particular device than is present in the base ABI doc. A bit like when we have additional description for dt binding properties for a particular device, even though they are standard properties. Often a standard property allows for more values than the specific one for a particular device. There can also be obscuring coupling between sysfs attributes due to hardware restrictions that we would like to provide some explanatory info on. I suppose we could add all this information to the parent doc but that is pretty ugly and will make that doc very nasty to read. Jonathan
$ ./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