mbox series

[0/4] iio: ABI: audit calibscal and calibbias attributes

Message ID 20240815-iio-abi-calib-audit-v1-0-536b2fea8620@baylibre.com (mailing list archive)
Headers show
Series iio: ABI: audit calibscal and calibbias attributes | expand

Message

David Lechner Aug. 15, 2024, 5:22 p.m. UTC
While preparing to add some new variants of the calib{scale,bias} and
calib{scale,bias}_available attributes, we noticed that quite a few
of the existing attributes were not documented.

---
David Lechner (4):
      iio: ABI: document calibscale_available attributes
      iio: ABI: sort calibscale attributes
      iio: ABI: add missing calibscale attributes
      iio: ABI: add missing calibbias attributes

 Documentation/ABI/testing/sysfs-bus-iio | 64 ++++++++++++++++++++++++++-------
 1 file changed, 51 insertions(+), 13 deletions(-)
---
base-commit: d505a9dc8de83df2a8ce8c9e780f7b29887f34af
change-id: 20240815-iio-abi-calib-audit-fcc21b1c6892

Comments

Jonathan Cameron Aug. 17, 2024, 2:52 p.m. UTC | #1
On Thu, 15 Aug 2024 12:22:09 -0500
David Lechner <dlechner@baylibre.com> wrote:

> While preparing to add some new variants of the calib{scale,bias} and
> calib{scale,bias}_available attributes, we noticed that quite a few
> of the existing attributes were not documented.
Thanks for tidying these up.

There are some scripts about (I think Mauro Carvalho Chehab wrote them) that
scan sysfs on a particular machine and report missing docs, but we've
never put in place anything that looks at the code to figure them out.

Gut feeling, too fiddly to maintain such a script for constructed attributes
my maybe could be done for const ones with the standard macros
(so pretty much nothing in IIO :)

Applied,

Jonathan


> 
> ---
> David Lechner (4):
>       iio: ABI: document calibscale_available attributes
>       iio: ABI: sort calibscale attributes
>       iio: ABI: add missing calibscale attributes
>       iio: ABI: add missing calibbias attributes
> 
>  Documentation/ABI/testing/sysfs-bus-iio | 64 ++++++++++++++++++++++++++-------
>  1 file changed, 51 insertions(+), 13 deletions(-)
> ---
> base-commit: d505a9dc8de83df2a8ce8c9e780f7b29887f34af
> change-id: 20240815-iio-abi-calib-audit-fcc21b1c6892
David Lechner Aug. 19, 2024, 7:50 p.m. UTC | #2
On 8/17/24 9:52 AM, Jonathan Cameron wrote:
> On Thu, 15 Aug 2024 12:22:09 -0500
> David Lechner <dlechner@baylibre.com> wrote:
> 
>> While preparing to add some new variants of the calib{scale,bias} and
>> calib{scale,bias}_available attributes, we noticed that quite a few
>> of the existing attributes were not documented.
> Thanks for tidying these up.
> 
> There are some scripts about (I think Mauro Carvalho Chehab wrote them) that
> scan sysfs on a particular machine and report missing docs, but we've
> never put in place anything that looks at the code to figure them out.

Thanks for the tip. Currently, 

	./scripts/get_abi.pl undefined --search-string=iio

doesn't catch anything because we have documented the directory

	What: /sys/bus/iio/devices/iio:deviceX

which gets translated to the regex

	/sys/.*/iio\:device.*

which matches everything under the iio:device directory.

Maybe `[XYZ]` should get converted to `[^/]*` instead of `.*`?

> 
> Gut feeling, too fiddly to maintain such a script for constructed attributes
> my maybe could be done for const ones with the standard macros
> (so pretty much nothing in IIO :)
> 
> Applied,
> 
> Jonathan
> 
> 
>>
>> ---
>> David Lechner (4):
>>       iio: ABI: document calibscale_available attributes
>>       iio: ABI: sort calibscale attributes
>>       iio: ABI: add missing calibscale attributes
>>       iio: ABI: add missing calibbias attributes
>>
>>  Documentation/ABI/testing/sysfs-bus-iio | 64 ++++++++++++++++++++++++++-------
>>  1 file changed, 51 insertions(+), 13 deletions(-)
>> ---
>> base-commit: d505a9dc8de83df2a8ce8c9e780f7b29887f34af
>> change-id: 20240815-iio-abi-calib-audit-fcc21b1c6892
>