linux-kernel - Re: [PATCH 27/27] Documentation: x86: convert x86

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190427154202.2b25c281@coco.lan>
Date:   Sat, 27 Apr 2019 15:42:02 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
To:     Changbin Du <changbin.du@...il.com>
Cc:     Jonathan Corbet <corbet@....net>, tglx@...utronix.de,
        mingo@...hat.com, bp@...en8.de, x86@...nel.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 27/27] Documentation: x86: convert x86_64/machinecheck
 to reST

Em Fri, 26 Apr 2019 23:31:50 +0800
Changbin Du <changbin.du@...il.com> escreveu:

> 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@...il.com>
> ---
>  Documentation/x86/x86_64/index.rst                    |  1 +
>  .../x86/x86_64/{machinecheck => machinecheck.rst}     | 11 ++++++-----
>  2 files changed, 7 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..8e9d2d529a8d 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,12 @@ 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)

Hmm.. I would add a blank line here.

After such change:

Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>

>  	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.



Thanks,
Mauro