lkml.org 
[lkml]   [2023]   [Feb]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v2 0/3] iio: Improce kernel docs
On Sat, 25 Feb 2023 15:53:22 +0200
Matti Vaittinen <mazziesaccount@gmail.com> 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@gmail.com/

Not sure I'll get to these today, so just a quick: typo in cover letter typo
in case I forget. Improve


>
> Patches 2 and 3 were added as a result of discussion followed by the
> RFC.
>
> Revision history:
> 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: c9c3395d5e3dcc6daee66c6908354d47bf98cb0c

\
 
 \ /
  Last update: 2023-03-27 00:36    [W:0.125 / U:0.500 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site