From: Jonathan Corbet <corbet@lwn.net>
To: Philipp Zabel <p.zabel@pengutronix.de>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Vivek Gautam <vivek.gautam@codeaurora.org>,
Masahiro Yamada <yamada.masahiro@socionext.com>,
Bartosz Golaszewski <bgolaszewski@baylibre.com>,
Hans de Goede <hdegoede@redhat.com>,
Martin Blumenstingl <martin.blumenstingl@googlemail.com>,
Ramiro Oliveira <Ramiro.Oliveira@synopsys.com>,
Dinh Nguyen <dinguyen@kernel.org>,
Thierry Reding <treding@nvidia.com>,
Geert Uytterhoeven <geert@linux-m68k.org>,
Lee Jones <lee.jones@linaro.org>,
kernel@pengutronix.de
Subject: Re: [RFC] docs: add a reset controller chapter to the driver API docs
Date: Tue, 22 Oct 2019 11:00:36 -0600 [thread overview]
Message-ID: <20191022110036.5c2edc05@lwn.net> (raw)
In-Reply-To: <20191022164547.22632-1-p.zabel@pengutronix.de>
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.
Thanks,
jon
next prev parent reply other threads:[~2019-10-22 17:00 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-22 16:45 [RFC] docs: add a reset controller chapter to the driver API docs Philipp Zabel
2019-10-22 17:00 ` Jonathan Corbet [this message]
2019-10-24 8:18 ` Philipp Zabel
2019-10-23 3:56 ` Randy Dunlap
2019-10-24 8:43 ` Philipp Zabel
2019-10-24 18:31 ` kbuild test robot
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191022110036.5c2edc05@lwn.net \
--to=corbet@lwn.net \
--cc=Ramiro.Oliveira@synopsys.com \
--cc=bgolaszewski@baylibre.com \
--cc=dinguyen@kernel.org \
--cc=geert@linux-m68k.org \
--cc=hdegoede@redhat.com \
--cc=kernel@pengutronix.de \
--cc=lee.jones@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=martin.blumenstingl@googlemail.com \
--cc=p.zabel@pengutronix.de \
--cc=treding@nvidia.com \
--cc=vivek.gautam@codeaurora.org \
--cc=yamada.masahiro@socionext.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.