linux-gpio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Changbin Du <changbin.du@gmail.com>
To: rjw@rjwysocki.net, Jonathan Corbet <corbet@lwn.net>
Cc: Bjorn Helgaas <bhelgaas@google.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	fenghua.yu@intel.com, linuxppc-dev@lists.ozlabs.org,
	linux-acpi@vger.kernel.org, linux-gpio@vger.kernel.org,
	mchehab+samsung@kernel.org, Changbin Du <changbin.du@gmail.com>
Subject: [PATCH v5 03/23] Documentation: ACPI: move osi.txt to firmware-guide/acpi and convert to reST
Date: Thu, 25 Apr 2019 01:52:46 +0800	[thread overview]
Message-ID: <20190424175306.25880-4-changbin.du@gmail.com> (raw)
In-Reply-To: <20190424175306.25880-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>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/firmware-guide/acpi/index.rst       |  1 +
 .../{acpi/osi.txt => firmware-guide/acpi/osi.rst} | 15 +++++++++------
 2 files changed, 10 insertions(+), 6 deletions(-)
 rename Documentation/{acpi/osi.txt => firmware-guide/acpi/osi.rst} (97%)

diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
index 99677c73f1fb..868bd25a3398 100644
--- a/Documentation/firmware-guide/acpi/index.rst
+++ b/Documentation/firmware-guide/acpi/index.rst
@@ -9,3 +9,4 @@ ACPI Support
 
    namespace
    enumeration
+   osi
diff --git a/Documentation/acpi/osi.txt b/Documentation/firmware-guide/acpi/osi.rst
similarity index 97%
rename from Documentation/acpi/osi.txt
rename to Documentation/firmware-guide/acpi/osi.rst
index 50cde0ceb9b0..29e9ef79ebc0 100644
--- a/Documentation/acpi/osi.txt
+++ b/Documentation/firmware-guide/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

  parent reply	other threads:[~2019-04-24 17:52 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-24 17:52 [PATCH v5 00/23] Include linux ACPI docs into Sphinx TOC tree Changbin Du
2019-04-24 17:52 ` [PATCH v5 01/23] Documentation: ACPI: move namespace.txt to firmware-guide/acpi and convert to reST Changbin Du
2019-04-24 17:52 ` [PATCH v5 02/23] Documentation: ACPI: move enumeration.txt " Changbin Du
2019-04-24 17:52 ` Changbin Du [this message]
2019-04-24 17:52 ` [PATCH v5 04/23] Documentation: ACPI: move linuxized-acpica.txt to driver-api/acpi " Changbin Du
2019-04-24 17:52 ` [PATCH v5 05/23] Documentation: ACPI: move scan_handlers.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 06/23] Documentation: ACPI: move DSD-properties-rules.txt to firmware-guide/acpi and covert " Changbin Du
2019-04-24 17:52 ` [PATCH v5 07/23] Documentation: ACPI: move gpio-properties.txt to firmware-guide/acpi and convert " Changbin Du
2019-04-24 17:52 ` [PATCH v5 08/23] Documentation: ACPI: move method-customizing.txt " Changbin Du
2019-04-24 18:08   ` Mauro Carvalho Chehab
2019-04-24 17:52 ` [PATCH v5 09/23] Documentation: ACPI: move initrd_table_override.txt to admin-guide/acpi " Changbin Du
2019-04-24 17:52 ` [PATCH v5 10/23] Documentation: ACPI: move dsdt-override.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 11/23] Documentation: ACPI: move i2c-muxes.txt to firmware-guide/acpi " Changbin Du
2019-04-24 17:52 ` [PATCH v5 12/23] Documentation: ACPI: move acpi-lid.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 13/23] Documentation: ACPI: move dsd/graph.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 14/23] Documentation: ACPI: move dsd/data-node-references.txt " Changbin Du
2019-04-24 18:10   ` Mauro Carvalho Chehab
2019-04-24 17:52 ` [PATCH v5 15/23] Documentation: ACPI: move debug.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 16/23] Documentation: ACPI: move method-tracing.txt to firmware-guide/acpi and convert to rsST Changbin Du
2019-04-24 17:53 ` [PATCH v5 17/23] Documentation: ACPI: move aml-debugger.txt to firmware-guide/acpi and convert to reST Changbin Du
2019-04-24 17:53 ` [PATCH v5 18/23] Documentation: ACPI: move apei/output_format.txt " Changbin Du
2019-04-24 17:53 ` [PATCH v5 19/23] Documentation: ACPI: move apei/einj.txt " Changbin Du
2019-04-24 17:53 ` [PATCH v5 20/23] Documentation: ACPI: move cppc_sysfs.txt to admin-guide/acpi " Changbin Du
2019-04-24 18:12   ` Mauro Carvalho Chehab
2019-04-25  0:44     ` Changbin Du
2019-04-24 17:53 ` [PATCH v5 21/23] Documentation: ACPI: move lpit.txt to firmware-guide/acpi " Changbin Du
2019-04-24 17:53 ` [PATCH v5 22/23] Documentation: ACPI: move ssdt-overlays.txt to admin-guide/acpi " Changbin Du
2019-04-24 17:53 ` [PATCH v5 23/23] Documentation: ACPI: move video_extension.txt to firmware-guide/acpi " Changbin Du
2019-04-24 18:26   ` Mauro Carvalho Chehab
2019-04-25  8:44 ` [PATCH v5 00/23] Include linux ACPI docs into Sphinx TOC tree Rafael J. Wysocki
2019-04-25 15:20   ` Changbin Du
2019-05-01 10:15     ` Rafael J. Wysocki

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=20190424175306.25880-4-changbin.du@gmail.com \
    --to=changbin.du@gmail.com \
    --cc=bhelgaas@google.com \
    --cc=corbet@lwn.net \
    --cc=fenghua.yu@intel.com \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=mchehab+samsung@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).