lkml.org 
[lkml]   [2021]   [Feb]   [5]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH v10 3/7] Documentation: ACPI: Document _DSE object usage for enum power state
From
Date
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

\
 
 \ /
  Last update: 2021-02-06 04:07    [W:0.238 / U:0.756 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site