From: Randy Dunlap <rdunlap@infradead.org>
To: Sakari Ailus <sakari.ailus@linux.intel.com>, linux-i2c@vger.kernel.org
Cc: Wolfram Sang <wsa@the-dreams.de>,
"Rafael J. Wysocki" <rafael@kernel.org>,
linux-acpi@vger.kernel.org, linux-kernel@vger.kernel.org,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
rajmohan.mani@intel.com, Tomasz Figa <tfiga@chromium.org>,
Bartosz Golaszewski <bgolaszewski@baylibre.com>,
Bingbu Cao <bingbu.cao@intel.com>,
Chiranjeevi Rapolu <chiranjeevi.rapolu@intel.com>,
Hyungwoo Yang <hyungwoo.yang@intel.com>,
linux-media@vger.kernel.org
Subject: Re: [PATCH v10 3/7] Documentation: ACPI: Document _DSE object usage for enum power state
Date: Fri, 5 Feb 2021 16:56:47 -0800 [thread overview]
Message-ID: <4894ef52-71f5-c651-c45b-4788f0e24162@infradead.org> (raw)
In-Reply-To: <20210205132505.20173-4-sakari.ailus@linux.intel.com>
On 2/5/21 5:25 AM, Sakari Ailus wrote:
> Document the use of the _DSE object for setting desirable power state
> during probe.
>
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> Reviewed-by: Tomasz Figa <tfiga@chromium.org>
> ---
> Documentation/firmware-guide/acpi/index.rst | 1 +
> .../firmware-guide/acpi/low-power-probe.rst | 69 +++++++++++++++++++
> 2 files changed, 70 insertions(+)
> create mode 100644 Documentation/firmware-guide/acpi/low-power-probe.rst
>
> diff --git a/Documentation/firmware-guide/acpi/low-power-probe.rst b/Documentation/firmware-guide/acpi/low-power-probe.rst
> new file mode 100644
> index 0000000000000..b96804d959a6c
> --- /dev/null
> +++ b/Documentation/firmware-guide/acpi/low-power-probe.rst
> @@ -0,0 +1,69 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +======================================
> +Probing I²C devices in low power state
> +======================================
> +
> +Introduction
> +============
> +
> +In some cases it may be preferred to leave certain devices powered off for the
> +entire system bootup if powering on these devices has adverse side effects,
> +beyond just powering on the said device.
> +
> +How it works
> +============
>
Hi,
Please don't use ============ underlines for all section levels.
Here is what Documentation/doc-guide/sphinx.rst says:
Specific guidelines for the kernel documentation
------------------------------------------------
Here are some specific guidelines for the kernel documentation:
* Please don't go overboard with reStructuredText markup. Keep it
simple. For the most part the documentation should be plain text with
just enough consistency in formatting that it can be converted to
other formats.
* Please keep the formatting changes minimal when converting existing
documentation to reStructuredText.
* Also update the content, not just the formatting, when converting
documentation.
* Please stick to this order of heading adornments:
1. ``=`` with overline for document title::
==============
Document title
==============
2. ``=`` for chapters::
Chapters
========
3. ``-`` for sections::
Section
-------
4. ``~`` for subsections::
Subsection
~~~~~~~~~~
Although RST doesn't mandate a specific order ("Rather than imposing a fixed
number and order of section title adornment styles, the order enforced will be
the order as encountered."), having the higher levels the same overall makes
it easier to follow the documents.
thanks.
--
~Randy
next prev parent reply other threads:[~2021-02-06 3:08 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-05 13:24 [PATCH v10 0/7] Support running driver's probe for a device powered off Sakari Ailus
2021-02-05 13:24 ` [PATCH v10 1/7] ACPI: scan: Obtain device's desired enumeration power state Sakari Ailus
2021-02-05 13:25 ` [PATCH v10 2/7] i2c: Allow an ACPI driver to manage the device's power state during probe Sakari Ailus
2021-02-09 21:04 ` Wolfram Sang
2021-02-10 20:46 ` Sakari Ailus
2021-02-10 22:27 ` Sakari Ailus
2021-02-12 7:18 ` Wolfram Sang
2021-02-05 13:25 ` [PATCH v10 3/7] Documentation: ACPI: Document _DSE object usage for enum power state Sakari Ailus
2021-02-06 0:56 ` Randy Dunlap [this message]
2021-02-08 8:01 ` Sakari Ailus
2021-02-08 15:52 ` Randy Dunlap
2021-02-05 13:25 ` [PATCH v10 4/7] ACPI: Add a convenience function to tell a device is in low " Sakari Ailus
2021-02-05 13:25 ` [PATCH v10 5/7] ov5670: Support probe whilst the device is in a " Sakari Ailus
2021-02-05 13:25 ` [PATCH v10 6/7] media: i2c: imx319: Support probe while the device is off Sakari Ailus
2021-02-05 13:25 ` [PATCH v10 7/7] at24: Support probing while off Sakari Ailus
2021-02-08 16:44 ` Bartosz Golaszewski
2021-02-08 16:54 ` Rafael J. Wysocki
2021-02-09 15:49 ` Bartosz Golaszewski
2021-02-09 16:23 ` Sakari Ailus
2021-02-09 16:42 ` Rafael J. Wysocki
2021-02-09 16:54 ` Sakari Ailus
2021-02-09 16:58 ` Rafael J. Wysocki
2021-02-10 8:41 ` Sakari Ailus
2021-02-10 12:26 ` Bartosz Golaszewski
2021-02-10 20:46 ` Sakari Ailus
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=4894ef52-71f5-c651-c45b-4788f0e24162@infradead.org \
--to=rdunlap@infradead.org \
--cc=bgolaszewski@baylibre.com \
--cc=bingbu.cao@intel.com \
--cc=chiranjeevi.rapolu@intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=hyungwoo.yang@intel.com \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=rafael@kernel.org \
--cc=rajmohan.mani@intel.com \
--cc=sakari.ailus@linux.intel.com \
--cc=tfiga@chromium.org \
--cc=wsa@the-dreams.de \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).