linux-kernel - Re: [PATCH v6 2/3] Documentation: ABI: added filter mode doc in sysfs-bus-iio

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 for Android: free password hash cracker in your pocket

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

Message-ID: <20240928185244.678bfa46@jic23-huawei>
Date: Sat, 28 Sep 2024 18:52:44 +0100
From: Jonathan Cameron <jic23@...nel.org>
To: Andy Shevchenko <andy@...nel.org>
Cc: Ramona Alexandra Nechita <ramona.nechita@...log.com>, Lars-Peter Clausen
 <lars@...afoo.de>, Michael Hennerich <Michael.Hennerich@...log.com>, Rob
 Herring <robh@...nel.org>, Krzysztof Kozlowski <krzk+dt@...nel.org>, Conor
 Dooley <conor+dt@...nel.org>, Nuno Sa <nuno.sa@...log.com>, David Lechner
 <dlechner@...libre.com>, Marcelo Schmitt <marcelo.schmitt@...log.com>,
 Olivier Moysan <olivier.moysan@...s.st.com>, Dumitru Ceclan
 <mitrutzceclan@...il.com>, Matteo Martelli <matteomartelli3@...il.com>,
 João Paulo Gonçalves
 <joao.goncalves@...adex.com>, Alisa-Dariana Roman <alisadariana@...il.com>,
 Marius Cristea <marius.cristea@...rochip.com>, linux-iio@...r.kernel.org,
 linux-kernel@...r.kernel.org, devicetree@...r.kernel.org
Subject: Re: [PATCH v6 2/3] Documentation: ABI: added filter mode doc in
 sysfs-bus-iio

On Thu, 26 Sep 2024 17:12:50 +0300
Andy Shevchenko <andy@...nel.org> wrote:

> On Thu, Sep 26, 2024 at 05:12:02PM +0300, Andy Shevchenko wrote:
> > On Thu, Sep 26, 2024 at 04:53:56PM +0300, Ramona Alexandra Nechita wrote:  
> 
> ...
> 
> > > +Description:
> > > +		Reading returns a list with the possible filter modes. Options
> > > +		for the attribute:
> > > +			* "sinc3"	- The digital sinc3 filter. Moderate 1st conversion time.
> > > +		    Good noise performance.
> > > +			* "sinc4"       - Sinc 4. Excellent noise performance. Long
> > > +			1st conversion time.
> > > +			* "sinc5"	- The digital sinc5 filter. Excellent noise performance
> > > +			* "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion
> > > +		    time.
> > > +			* "sinc3+rej60" - Sinc3 + 60Hz rejection.
> > > +			* "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion
> > > +		    time.
> > > +			* "sinc3+pf1"   - Sinc3 + device specific Post Filter 1.
> > > +			* "sinc3+pf2"   - Sinc3 + device specific Post Filter 2.
> > > +			* "sinc3+pf3"   - Sinc3 + device specific Post Filter 3.
> > > +			* "sinc3+pf4"   - Sinc3 + device specific Post Filter 4.  
> > 
> > I still think that a compromise to leave the existing values as an example in  
> 
> > the existing bindings is a good to have.
  
It gets hard to do really quickly because we end up with effectively a full set
of docs for each one.  I'd like to capture that information but I'm not sure ABI
docs are the right place because we don't want each entry to followed by pages
of specific examples. 

I'd have loved the option for ABI docs to have extra info in a per device
file that doesn't end up in the main docs build but we don't have that yet.

Jonathan

> 
> s/existing/generic/
> 
>