linux-kernel.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 04/23] acpi doc: convert acpi/osi.txt to rst format
Date: Fri, 29 Mar 2019 00:27:02 +0800	[thread overview]
Message-ID: <20190328162721.26138-5-changbin.du@gmail.com> (raw)
In-Reply-To: <20190328162721.26138-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/{osi.txt => osi.rst} | 13 +++++++------
 2 files changed, 8 insertions(+), 6 deletions(-)
 rename Documentation/acpi/{osi.txt => osi.rst} (97%)

diff --git a/Documentation/acpi/index.rst b/Documentation/acpi/index.rst
index 624eb95e982b..1b5459e46533 100644
--- a/Documentation/acpi/index.rst
+++ b/Documentation/acpi/index.rst
@@ -7,3 +7,4 @@ Linux ACPI (Advanced Configuration and Power Interface)
 
    namespace
    enumeration
+   osi
diff --git a/Documentation/acpi/osi.txt b/Documentation/acpi/osi.rst
similarity index 97%
rename from Documentation/acpi/osi.txt
rename to Documentation/acpi/osi.rst
index 50cde0ceb9b0..47aaedd1013a 100644
--- a/Documentation/acpi/osi.txt
+++ b/Documentation/acpi/osi.rst
@@ -1,5 +1,6 @@
+==========================
 ACPI _OSI and _REV methods
---------------------------
+==========================
 
 An ACPI BIOS can use the "Operating System Interfaces" method (_OSI)
 to find out what the operating system supports. Eg. If BIOS
@@ -14,7 +15,7 @@ This document explains how and why the BIOS and Linux should use these methods.
 It also explains how and why they are widely misused.
 
 How to use _OSI
----------------
+===============
 
 Linux runs on two groups of machines -- those that are tested by the OEM
 to be compatible with Linux, and those that were never tested with Linux,
@@ -62,7 +63,7 @@ the string when that support is added to the kernel.
 That was easy.  Read on, to find out how to do it wrong.
 
 Before _OSI, there was _OS
---------------------------
+==========================
 
 ACPI 1.0 specified "_OS" as an
 "object that evaluates to a string that identifies the operating system."
@@ -96,7 +97,7 @@ That is the *only* viable strategy, as that is what modern Windows does,
 and so doing otherwise could steer the BIOS down an untested path.
 
 _OSI is born, and immediately misused
---------------------------------------
+=====================================
 
 With _OSI, the *BIOS* provides the string describing an interface,
 and asks the OS: "YES/NO, are you compatible with this interface?"
@@ -144,7 +145,7 @@ catastrophic failure resulting from the BIOS taking paths that
 were never validated under *any* OS.
 
 Do not use _REV
----------------
+===============
 
 Since _OSI("Linux") went away, some BIOS writers used _REV
 to support Linux and Windows differences in the same BIOS.
@@ -164,7 +165,7 @@ from mid-2015 onward.  The ACPI specification will also be updated
 to reflect that _REV is deprecated, and always returns 2.
 
 Apple Mac and _OSI("Darwin")
-----------------------------
+============================
 
 On Apple's Mac platforms, the ACPI BIOS invokes _OSI("Darwin")
 to determine if the machine is running Apple OSX.
-- 
2.20.1


  parent reply	other threads:[~2019-03-28 16:28 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-28 16:26 [PATCH 00/23] Include linux ACPI docs into Sphinx TOC tree Changbin Du
2019-03-28 16:26 ` [PATCH 01/23] Documentation: add Linux ACPI to " Changbin Du
2019-03-28 16:27 ` [PATCH 02/23] acpi doc: convert acpi/namespace.txt to rst format Changbin Du
2019-03-28 16:27 ` [PATCH 03/23] acpi doc: convert acpi/enumeration.txt " Changbin Du
2019-03-28 16:27 ` Changbin Du [this message]
2019-03-28 16:27 ` [PATCH 05/23] acpi doc: convert acpi/linuxized-acpica.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 06/23] acpi doc: convert acpi/scan_handlers.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 07/23] acpi doc: convert acpi/DSD-properties-rules.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 08/23] acpi doc: convert acpi/gpio-properties.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 09/23] acpi doc: convert acpi/method-customizing.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 10/23] acpi doc: convert acpi/initrd_table_override.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 11/23] acpi doc: convert acpi/dsdt-override.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 12/23] acpi doc: convert acpi/i2c-muxes.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 13/23] acpi doc: convert acpi/acpi-lid.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 14/23] acpi doc: convert acpi/dsd/graph.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 15/23] acpi doc: convert acpi/debug.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 16/23] acpi doc: convert acpi/method-tracing.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 17/23] acpi doc: convert acpi/aml-debugger.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 18/23] acpi doc: convert acpi/apei/output_format.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 19/23] acpi doc: convert acpi/apei/einj.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 20/23] acpi doc: convert acpi/cppc_sysfs.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 21/23] acpi doc: convert acpi/lpit.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 22/23] acpi doc: convert acpi/ssdt-overlays.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 23/23] acpi doc: convert acpi/video_extension.txt " Changbin Du
2019-03-28 16:34 ` [PATCH 00/23] Include linux ACPI docs into Sphinx TOC tree Joe Perches
2019-03-29  0:08   ` Changbin Du
2019-03-28 16:39 ` Jonathan Corbet
2019-03-29  0:10   ` 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=20190328162721.26138-5-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).