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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <d6a6097b-cc48-4213-a5bf-7b154870ce0b@gmail.com>
Date:   Fri, 24 Feb 2023 16:44:48 +0200
From:   Matti Vaittinen <mazziesaccount@...il.com>
To:     Andy Shevchenko <andy.shevchenko@...il.com>
Cc:     Matti Vaittinen <matti.vaittinen@...rohmeurope.com>,
        Jonathan Cameron <Jonathan.Cameron@...wei.com>,
        Andrea Merello <andrea.merello@....it>,
        Jagath Jog J <jagathjog1996@...il.com>,
        linux-kernel@...r.kernel.org
Subject: Re: [RFC PATCH] iio: Add some kerneldoc for channel types

On 2/24/23 16:20, Andy Shevchenko wrote:
> On Fri, Feb 24, 2023 at 3:02 PM Matti Vaittinen
> <mazziesaccount@...il.com> 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! ~~