linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Changbin Du <changbin.du@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: rjw@rjwysocki.net, lenb@kernel.org, linux-acpi@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	Changbin Du <changbin.du@gmail.com>
Subject: [PATCH v2 22/24] acpi doc: convert acpi/lpit.txt to rst format
Date: Fri, 29 Mar 2019 08:11:33 +0800	[thread overview]
Message-ID: <20190329001135.15847-23-changbin.du@gmail.com> (raw)
In-Reply-To: <20190329001135.15847-1-changbin.du@gmail.com>

This converts the plain text documentation to reStructuredText format and
add it to Sphinx TOC tree. No essential content change.

Signed-off-by: Changbin Du <changbin.du@gmail.com>
---
 Documentation/acpi/index.rst              |  1 +
 Documentation/acpi/{lpit.txt => lpit.rst} | 18 +++++++++++++-----
 2 files changed, 14 insertions(+), 5 deletions(-)
 rename Documentation/acpi/{lpit.txt => lpit.rst} (68%)

diff --git a/Documentation/acpi/index.rst b/Documentation/acpi/index.rst
index 91aeed814ea9..664807949272 100644
--- a/Documentation/acpi/index.rst
+++ b/Documentation/acpi/index.rst
@@ -27,3 +27,4 @@ Linux ACPI (Advanced Configuration and Power Interface)
    apei/output_format
    apei/einj
    cppc_sysfs
+   lpit
diff --git a/Documentation/acpi/lpit.txt b/Documentation/acpi/lpit.rst
similarity index 68%
rename from Documentation/acpi/lpit.txt
rename to Documentation/acpi/lpit.rst
index b426398d2e97..aca928fab027 100644
--- a/Documentation/acpi/lpit.txt
+++ b/Documentation/acpi/lpit.rst
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===========================
+Low Power Idle Table (LPIT)
+===========================
+
 To enumerate platform Low Power Idle states, Intel platforms are using
 “Low Power Idle Table” (LPIT). More details about this table can be
 downloaded from:
@@ -8,13 +14,15 @@ Residencies for each low power state can be read via FFH
 
 On platforms supporting S0ix sleep states, there can be two types of
 residencies:
-- CPU PKG C10 (Read via FFH interface)
-- Platform Controller Hub (PCH) SLP_S0 (Read via memory mapped interface)
+
+  - CPU PKG C10 (Read via FFH interface)
+  - Platform Controller Hub (PCH) SLP_S0 (Read via memory mapped interface)
 
 The following attributes are added dynamically to the cpuidle
-sysfs attribute group:
-	/sys/devices/system/cpu/cpuidle/low_power_idle_cpu_residency_us
-	/sys/devices/system/cpu/cpuidle/low_power_idle_system_residency_us
+sysfs attribute group::
+
+  /sys/devices/system/cpu/cpuidle/low_power_idle_cpu_residency_us
+  /sys/devices/system/cpu/cpuidle/low_power_idle_system_residency_us
 
 The "low_power_idle_cpu_residency_us" attribute shows time spent
 by the CPU package in PKG C10
-- 
2.20.1


  parent reply	other threads:[~2019-03-29  0:14 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-29  0:11 [PATCH v2 00/24] Include linux ACPI docs into Sphinx TOC tree Changbin Du
2019-03-29  0:11 ` [PATCH v2 01/24] Documentation: add Linux ACPI to " Changbin Du
2019-03-30  9:51   ` Rafael J. Wysocki
2019-03-31  5:13     ` Changbin Du
2019-03-29  0:11 ` [PATCH v2 02/24] acpi doc: convert acpi/namespace.txt to rst format Changbin Du
2019-03-29  0:11 ` [PATCH v2 03/24] acpi doc: convert acpi/enumeration.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 04/24] acpi doc: convert acpi/osi.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 05/24] acpi doc: convert acpi/linuxized-acpica.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 06/24] acpi doc: convert acpi/scan_handlers.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 07/24] acpi doc: convert acpi/DSD-properties-rules.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 08/24] acpi doc: convert acpi/gpio-properties.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 09/24] acpi doc: convert acpi/method-customizing.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 10/24] acpi doc: convert acpi/initrd_table_override.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 11/24] acpi doc: convert acpi/dsdt-override.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 12/24] acpi doc: convert acpi/i2c-muxes.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 13/24] acpi doc: convert acpi/acpi-lid.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 14/24] acpi doc: convert acpi/dsd/graph.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 15/24] acpi doc: convert acpi/dsd/data-node-references.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 16/24] acpi doc: convert acpi/debug.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 17/24] acpi doc: convert acpi/method-tracing.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 18/24] acpi doc: convert acpi/aml-debugger.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 19/24] acpi doc: convert acpi/apei/output_format.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 20/24] acpi doc: convert acpi/apei/einj.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 21/24] acpi doc: convert acpi/cppc_sysfs.txt " Changbin Du
2019-03-29  0:11 ` Changbin Du [this message]
2019-03-29  0:11 ` [PATCH v2 23/24] acpi doc: convert acpi/ssdt-overlays.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 24/24] acpi doc: convert acpi/video_extension.txt " Changbin Du
2019-03-30  9:41 ` [PATCH v2 00/24] Include linux ACPI docs into Sphinx TOC tree Rafael J. Wysocki
2019-04-02  8:25   ` Rafael J. Wysocki
2019-04-03 19:36     ` Jonathan Corbet
2019-04-03 20:40       ` Andy Shevchenko
2019-04-09 16:35         ` Rafael J. Wysocki
2019-04-05  2:44       ` Changbin Du
2019-04-09 16:17         ` Changbin Du
2019-04-09 16:42       ` Rafael J. Wysocki
2019-04-09 21:26         ` Jonathan Corbet
2019-04-09 21:44           ` Rafael J. Wysocki
2019-04-11 15:12             ` Changbin Du

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=20190329001135.15847-23-changbin.du@gmail.com \
    --to=changbin.du@gmail.com \
    --cc=corbet@lwn.net \
    --cc=lenb@kernel.org \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rjw@rjwysocki.net \
    /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).