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

Philipp Zabel
2019-10-24T08:18:22Z

Hi Jonathan,

On Tue, 2019-10-22 at 11:00 -0600, Jonathan Corbet wrote:
> On Tue, 22 Oct 2019 18:45:47 +0200
> Philipp Zabel <p.zabel@pengutronix.de> wrote:
>
> > Add initial reset controller API documentation. This is mostly indented
> > to describe the concepts to users of the consumer API, and to tie the
> > kerneldoc comments we already have into the driver API documentation.
> >
> > Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de>
>
> One quick comment...
>
> > Documentation/driver-api/index.rst | 1 +
> > Documentation/driver-api/reset.rst | 217 +++++++++++++++++++++++++++++
> > 2 files changed, 218 insertions(+)
> > create mode 100644 Documentation/driver-api/reset.rst
> >
>
> [...]
>
> > +Shared and exclusive resets
> > +---------------------------
> > +
> > +The reset controller API provides either reference counted deassertion and
> > +assertion or direct, exclusive control.
> > +The distinction between shared and exclusive reset controls is made at the time
> > +the reset control is requested, either via :c:func:`devm_reset_control_get_shared`
> > +or via :c:func:`devm_reset_control_get_exclusive`.
>
> :c:func: isn't needed anymore, and is actively discouraged - the function
> references will be linked anyway. So just say function() rather than
> :c:func:`function` everywhere, please.

That is great, thank you! I'll change them all in the next version.

regards
Philipp