linux-kernel - Re: [RFC] docs: add a reset controller chapter to the driver API docs

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] [day] [month] [year] [list]

Message-ID: <cba736f135f150d685ab4efee625d69aa800d1c8.camel@pengutronix.de>
Date:   Thu, 24 Oct 2019 10:43:36 +0200
From:   Philipp Zabel <p.zabel@...gutronix.de>
To:     Randy Dunlap <rdunlap@...radead.org>, linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Vivek Gautam <vivek.gautam@...eaurora.org>,
        Masahiro Yamada <yamada.masahiro@...ionext.com>,
        Bartosz Golaszewski <bgolaszewski@...libre.com>,
        Hans de Goede <hdegoede@...hat.com>,
        Martin Blumenstingl <martin.blumenstingl@...glemail.com>,
        Ramiro Oliveira <Ramiro.Oliveira@...opsys.com>,
        Dinh Nguyen <dinguyen@...nel.org>,
        Thierry Reding <treding@...dia.com>,
        Geert Uytterhoeven <geert@...ux-m68k.org>,
        Lee Jones <lee.jones@...aro.org>, kernel@...gutronix.de
Subject: Re: [RFC] docs: add a reset controller chapter to the driver API
 docs

Hi Randy,

thank you for the corrections!

On Tue, 2019-10-22 at 20:56 -0700, Randy Dunlap wrote:
> On 10/22/19 9:45 AM, Philipp Zabel wrote:
> > Add initial reset controller API documentation. This is mostly indented
> 
>                                                                  intended

:) Makes me smile every time.

[...]
> > +====================
> > +Reset controller API
> > +====================
> > +
> > +Introduction
> > +============
> > +
> > +Reset controllers are central units that control the reset signals to multiple
> > +peripherals.
> > +The reset controller API is split in two parts:
> 
>                  I prefer            into two parts:

Ok. I think this might have come from "split in half".

[...]
> > +Consumer driver interface
> > +=========================
> > +
> > +This interface offers a similar API to the kernel clock framework.
> 
> or:
>   This interface provides an API that is similar to the kernel clock framework.

Yes, this is better as well. I'll change all three in the next version.

[...]
> > +.. kernel-doc:: drivers/reset/core.c
> > +   :functions: of_reset_simple_xlate
> > +               reset_controller_register
> > +               reset_controller_unregister
> > +               devm_reset_controller_register
> > +               reset_controller_add_lookup
> 
> These header and source files cause a number of kernel-doc warnings
> for which I am sending a patch.

Thank you, I have already sent fixes for the build warnings.
In hindsight, they probably should have been included as a series.

regards
Philipp