Re: [RFC PATCH] iio: Add some kerneldoc for channel types

From: Matti Vaittinen
Date: Fri Feb 24 2023 - 09:45:02 EST


On 2/24/23 16:20, Andy Shevchenko wrote:
On Fri, Feb 24, 2023 at 3:02 PM Matti Vaittinen
<mazziesaccount@xxxxxxxxx> wrote:

For occasional contributor like me navigating the IIO channel types and
modifiers may be a daunting task. One may have hard time finding out
what type of channel should be used for device data and what units the
data should be converted.

There is a great documentation for the sysfs interfaces though. What is
missing is mapping of the channel types and modifiers to the sysfs
documentation (and entries in documentation).

Give a hand to a driver writer by providing some documentation and by
pointing to the sysfs document from the kerneldocs of respective enums.

kernel doc

Documentation is always welcome!

...

Thanks for the review Andy. All comments valid and to the point - I'll fix these issues before respinning!

Yours,
-- Matti

--
Matti Vaittinen
Linux kernel developer at ROHM Semiconductors
Oulu Finland

~~ When things go utterly wrong vim users can always type :help! ~~