linux-kernel - Re: [PATCH] DocBook: Add initial documentation for 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: Windows password security audit tool. GUI, reports in PDF.

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

Date:	Fri, 17 Jul 2015 11:49:12 +0300
From:	Daniel Baluta <daniel.baluta@...el.com>
To:	Jonathan Corbet <corbet@....net>
Cc:	Daniel Baluta <daniel.baluta@...el.com>,
	Jonathan Cameron <jic23@...nel.org>,
	Peter Meerwald <pmeerw@...erw.net>,
	Hartmut Knaack <knaack.h@....de>,
	Lars-Peter Clausen <lars@...afoo.de>,
	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	"linux-iio@...r.kernel.org" <linux-iio@...r.kernel.org>,
	linux-doc@...r.kernel.org
Subject: Re: [PATCH] DocBook: Add initial documentation for IIO

On Thu, Jul 16, 2015 at 1:24 PM, Jonathan Corbet <corbet@....net> wrote:
> On Wed,  8 Jul 2015 15:04:48 +0300
> Daniel Baluta <daniel.baluta@...el.com> wrote:
>
>> This is intended to help developers faster find their way
>> inside the Industrial I/O core and reduce time spent on IIO
>> drivers development.
>
> Seems like good stuff to have, sorry it's taken me so long to have a look
> at it.  Any other IIO folks want to send comments or an ack?

Thanks a lot Jon for your time. I also missed to explicitly add you on the
Cc list. I will make use of get_maintainer.pl for v2.

>
> A few comments of mine below...

Will fix in v2. Few comments inline

<snip>

>> +
>> +      <para>
>> +        This program is distributed in the hope that it will be
>> +        useful, but WITHOUT ANY WARRANTY; without even the implied
>> +        warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
>> +        For more details see the file COPYING in the source
>> +        distribution of Linux.
>
> Do we really need this paragraph?  It's not even a "program" by some views,
> at least.

This paragraph is present in most of the already existing documentation.
E.g. First 6 docs from here: https://www.kernel.org/doc/htmldocs/ have it.

But you have a good point it doesn't make much sense here. I will
remove it in v2.

<snip>

>> +      Available standard attributes for IIO devices are described in the
>> +      <filename>Documentation/ABI/testing/sysfs-bus-iio </filename> file
>> +      in the Linux kernel sources.
>
> Should that move out of testing at some point?

This has been here for quite some time (4 years?), but IIO gets more and
more drivers with new features and new ABI attributes that are somehow
still in testing.

So, I think it should stay here for at least one more year. Or perhaps
we can split this file and move the stable part in ABI/stable and keep
the new ABI in testing.

Agree with all other comments will address them in v2.

thanks,
Daniel.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/