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 04/24] acpi doc: convert acpi/osi.txt to rst format
Date: Fri, 29 Mar 2019 08:11:15 +0800 [thread overview]
Message-ID: <20190329001135.15847-5-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/{osi.txt => osi.rst} | 15 +++++++++------
2 files changed, 10 insertions(+), 6 deletions(-)
rename Documentation/acpi/{osi.txt => osi.rst} (97%)
diff --git a/Documentation/acpi/index.rst b/Documentation/acpi/index.rst
index 52ff8d0a9ed6..d69c2a416909 100644
--- a/Documentation/acpi/index.rst
+++ b/Documentation/acpi/index.rst
@@ -9,3 +9,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..29e9ef79ebc0 100644
--- a/Documentation/acpi/osi.txt
+++ b/Documentation/acpi/osi.rst
@@ -1,5 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================
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 +17,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 +65,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 +99,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 +147,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 +167,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
next prev parent reply other threads:[~2019-03-29 0:12 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 ` Changbin Du [this message]
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 ` [PATCH v2 22/24] acpi doc: convert acpi/lpit.txt " Changbin Du
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-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).