All of lore.kernel.org
 help / color / mirror / Atom feed
From: Changbin Du <changbin.du@gmail.com>
To: corbet@lwn.net, tglx@linutronix.de, mingo@redhat.com, bp@alien8.de
Cc: x86@kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, Changbin Du <changbin.du@gmail.com>,
	Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Subject: [PATCH v2 27/27] Documentation: x86: convert x86_64/machinecheck to reST
Date: Thu,  2 May 2019 15:06:33 +0800	[thread overview]
Message-ID: <20190502070633.9809-28-changbin.du@gmail.com> (raw)
In-Reply-To: <20190502070633.9809-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/x86/x86_64/index.rst                   |  1 +
 .../x86/x86_64/{machinecheck => machinecheck.rst}    | 12 +++++++-----
 2 files changed, 8 insertions(+), 5 deletions(-)
 rename Documentation/x86/x86_64/{machinecheck => machinecheck.rst} (92%)

diff --git a/Documentation/x86/x86_64/index.rst b/Documentation/x86/x86_64/index.rst
index c04b6eab3c76..d6eaaa5a35fc 100644
--- a/Documentation/x86/x86_64/index.rst
+++ b/Documentation/x86/x86_64/index.rst
@@ -13,3 +13,4 @@ x86_64 Support
    5level-paging
    fake-numa-for-cpusets
    cpu-hotplug-spec
+   machinecheck
diff --git a/Documentation/x86/x86_64/machinecheck b/Documentation/x86/x86_64/machinecheck.rst
similarity index 92%
rename from Documentation/x86/x86_64/machinecheck
rename to Documentation/x86/x86_64/machinecheck.rst
index d0648a74fceb..e189168406fa 100644
--- a/Documentation/x86/x86_64/machinecheck
+++ b/Documentation/x86/x86_64/machinecheck.rst
@@ -1,5 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
 
-Configurable sysfs parameters for the x86-64 machine check code.
+===============================================================
+Configurable sysfs parameters for the x86-64 machine check code
+===============================================================
 
 Machine checks report internal hardware error conditions detected
 by the CPU. Uncorrected errors typically cause a machine check
@@ -16,14 +19,13 @@ log then mcelog should run to collect and decode machine check entries
 from /dev/mcelog. Normally mcelog should be run regularly from a cronjob.
 
 Each CPU has a directory in /sys/devices/system/machinecheck/machinecheckN
-(N = CPU number)
+(N = CPU number).
 
 The directory contains some configurable entries:
 
-Entries:
-
 bankNctl
-(N bank number)
+	(N bank number)
+
 	64bit Hex bitmask enabling/disabling specific subevents for bank N
 	When a bit in the bitmask is zero then the respective
 	subevent will not be reported.
-- 
2.20.1


  parent reply	other threads:[~2019-05-02  7:12 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-02  7:06 [PATCH v2 00/27] Include linux x86 docs into Sphinx TOC tree Changbin Du
2019-05-02  7:06 ` [PATCH v2 01/27] Documentation: add Linux x86 docs to " Changbin Du
2019-05-02  7:06 ` [PATCH v2 02/27] Documentation: x86: convert boot.txt to reST Changbin Du
2019-05-02  7:06 ` [PATCH v2 03/27] Documentation: x86: convert topology.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 04/27] Documentation: x86: convert exception-tables.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 05/27] Documentation: x86: convert kernel-stacks " Changbin Du
2019-05-02  7:06 ` [PATCH v2 06/27] Documentation: x86: convert entry_64.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 07/27] Documentation: x86: convert earlyprintk.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 08/27] Documentation: x86: convert zero-page.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 09/27] Documentation: x86: convert tlb.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 10/27] Documentation: x86: convert mtrr.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 11/27] Documentation: x86: convert pat.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 12/27] Documentation: x86: convert protection-keys.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 13/27] Documentation: x86: convert intel_mpx.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 14/27] Documentation: x86: convert amd-memory-encryption.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 15/27] Documentation: x86: convert pti.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 16/27] Documentation: x86: convert microcode.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 17/27] Documentation: x86: convert resctrl_ui.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 18/27] Documentation: x86: convert orc-unwinder.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 19/27] Documentation: x86: convert usb-legacy-support.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 20/27] Documentation: x86: convert i386/IO-APIC.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 21/27] Documentation: x86: convert x86_64/boot-options.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 22/27] Documentation: x86: convert x86_64/uefi.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 23/27] Documentation: x86: convert x86_64/mm.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 24/27] Documentation: x86: convert x86_64/5level-paging.txt " Changbin Du
2019-05-02  7:06 ` [PATCH v2 25/27] Documentation: x86: convert x86_64/fake-numa-for-cpusets " Changbin Du
2019-05-02  7:06 ` [PATCH v2 26/27] Documentation: x86: convert x86_64/cpu-hotplug-spec " Changbin Du
2019-05-02  7:06 ` Changbin Du [this message]
2019-05-03 12:43 ` [PATCH v2 00/27] Include linux x86 docs into Sphinx TOC tree Jonathan Corbet
2019-05-03 13:09   ` Borislav Petkov
2019-05-03 17:44   ` Ingo Molnar
2019-05-05 19:02 ` Jonathan Corbet
2019-05-06  0:06   ` 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=20190502070633.9809-28-changbin.du@gmail.com \
    --to=changbin.du@gmail.com \
    --cc=bp@alien8.de \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab+samsung@kernel.org \
    --cc=mingo@redhat.com \
    --cc=tglx@linutronix.de \
    --cc=x86@kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.