Re: [RESEND PATCH v2 0/3] Improve kernel docs

From: Jonathan Cameron
Date: Sat Apr 08 2023 - 05:34:48 EST


On Tue, 4 Apr 2023 15:24:15 +0300
Matti Vaittinen <mazziesaccount@xxxxxxxxx> wrote:

> IIO has very nice facilities for efficiently providing data from a
> device to user (and probably also vice-versa - but I've not used that
> direction). Getting started with IIO may not be so simple though - some
> of the concepts like triggers and buffers are quite unique.
>
> This series tries to make it easier for a newcomer to write his/her first
> IIO driver by adding some documentation to used enums. Series does not
> provide extensive documentation but just documents those few entries I
> have become familiar with - but it still aims to be a starting point for
> others to add missing bits and pieces.
>
> This series is marked as v2 because the patch 1 was previously sent as a
> stan-alone RFC to collect the missing channel units. RFC can be seen
> here:
> https://lore.kernel.org/all/10a855f9adc1d710150b7f647500c3c6a769f9ca.1677243698.git.mazziesaccount@xxxxxxxxx/
>
> Patches 2 and 3 were added as a result of discussion followed by the
> RFC.

Something odd happened on this resend. Patch 1 didn't make it to me
or patchwork. I'll reply to previous posting instead.

Jonathan

>
> Revision history:
> v2 resend:
> - rebased on v6.3-rc2
> RFCv1 => v2:
> - added patches 2 and 3
> - added missing channel type docs provided by Jonathan
> - added @in front of member names and fix typos pointed by Andy
> - dropped TODOs as Jonathan clarified the units
>
> ---
>
> Matti Vaittinen (3):
> iio: Add some kerneldoc for channel types
> iio: add documentation for iio_chan_info_enum
> doc: Make sysfs-bus-iio doc more exact
>
> Documentation/ABI/testing/sysfs-bus-iio | 11 +-
> include/linux/iio/types.h | 46 +++++++-
> include/uapi/linux/iio/types.h | 134 ++++++++++++++++++++++++
> 3 files changed, 185 insertions(+), 6 deletions(-)
>
>
> base-commit: eeac8ede17557680855031c6f305ece2378af326