netdev - Re: [PATCH 30/33] docs: ABI: cleanup several ABI documents

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: <87k0v8jk9s.fsf@vajain21.in.ibm.com>
Date:   Fri, 30 Oct 2020 12:03:03 +0530
From:   Vaibhav Jain <vaibhav@...ux.ibm.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Cc:     Andrew Lunn <andrew@...n.ch>, Peter Chen <peter.chen@....com>,
        Linus Walleij <linus.walleij@...aro.org>,
        Jerry Snitselaar <jsnitsel@...hat.com>,
        dri-devel@...ts.freedesktop.org, Pavel Machek <pavel@....cz>,
        Christian Gromm <christian.gromm@...rochip.com>,
        ceph-devel@...r.kernel.org, Kan Liang <kan.liang@...ux.intel.com>,
        Bart Van Assche <bvanassche@....org>,
        linux-acpi@...r.kernel.org,
        Danil Kipnis <danil.kipnis@...ud.ionos.com>,
        Samuel Thibault <samuel.thibault@...-lyon.org>,
        Guenter Roeck <linux@...ck-us.net>,
        Ohad Ben-Cohen <ohad@...ery.com>, linux-pm@...r.kernel.org,
        Simon Gaiser <simon@...isiblethingslab.com>,
        Avri Altman <avri.altman@....com>,
        Alexander Antonov <alexander.antonov@...ux.intel.com>,
        Dan Murphy <dmurphy@...com>,
        Thomas Gleixner <tglx@...utronix.de>,
        Stefan Achatz <erazor_de@...rs.sourceforge.net>,
        Konstantin Khlebnikov <koct9i@...il.com>,
        Mathieu Malaterre <malat@...ian.org>,
        Jingoo Han <jingoohan1@...il.com>,
        "Rafael J. Wysocki" <rjw@...ysocki.net>,
        linux-kernel@...r.kernel.org,
        Hans Verkuil <hverkuil-cisco@...all.nl>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Wu Hao <hao.wu@...el.com>,
        Peter Meerwald-Stadler <pmeerw@...erw.net>,
        Mimi Zohar <zohar@...ux.ibm.com>,
        Srinivas Kandagatla <srinivas.kandagatla@...aro.org>,
        Hanjun Guo <guohanjun@...wei.com>,
        Oleh Kravchenko <oleg@....org.ua>,
        Lars-Peter Clausen <lars@...afoo.de>,
        Andy Shevchenko <andriy.shevchenko@...el.com>,
        Saravana Kannan <saravanak@...gle.com>,
        Gregory CLEMENT <gregory.clement@...tlin.com>,
        Anton Vorontsov <anton@...msg.org>,
        Marek Marczykowski-Górecki 
        <marmarek@...isiblethingslab.com>,
        linux-stm32@...md-mailman.stormreply.com,
        Bartosz Golaszewski <bgolaszewski@...libre.com>,
        Len Brown <lenb@...nel.org>,
        Alexandre Torgue <alexandre.torgue@...com>,
        Michael Hennerich <Michael.Hennerich@...log.com>,
        Suzuki K Poulose <suzuki.poulose@....com>,
        coresight@...ts.linaro.org, linux-media@...r.kernel.org,
        Frederic@...av26.portsmouth.uk.ibm.com,
        "Barrat <fbarrat"@linux.ibm.com
Subject: Re: [PATCH 30/33] docs: ABI: cleanup several ABI documents

Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:

> There are some ABI documents that, while they don't generate
> any warnings, they have issues when parsed by get_abi.pl script
> on its output result.
>
> Address them, in order to provide a clean output.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

<snip>
> diff --git a/Documentation/ABI/testing/sysfs-bus-papr-pmem b/Documentation/ABI/testing/sysfs-bus-papr-pmem
> index c1a67275c43f..8316c33862a0 100644
> --- a/Documentation/ABI/testing/sysfs-bus-papr-pmem
> +++ b/Documentation/ABI/testing/sysfs-bus-papr-pmem
> @@ -11,19 +11,26 @@ Description:
>  		at 'Documentation/powerpc/papr_hcalls.rst' . Below are
>  		the flags reported in this sysfs file:
>  
> -		* "not_armed"	: Indicates that NVDIMM contents will not
> +		* "not_armed"
> +				  Indicates that NVDIMM contents will not
>  				  survive a power cycle.
> -		* "flush_fail"	: Indicates that NVDIMM contents
> +		* "flush_fail"
> +				  Indicates that NVDIMM contents
>  				  couldn't be flushed during last
>  				  shut-down event.
> -		* "restore_fail": Indicates that NVDIMM contents
> +		* "restore_fail"
> +				  Indicates that NVDIMM contents
>  				  couldn't be restored during NVDIMM
>  				  initialization.
> -		* "encrypted"	: NVDIMM contents are encrypted.
> -		* "smart_notify": There is health event for the NVDIMM.
> -		* "scrubbed"	: Indicating that contents of the
> +		* "encrypted"
> +				  NVDIMM contents are encrypted.
> +		* "smart_notify"
> +				  There is health event for the NVDIMM.
> +		* "scrubbed"
> +				  Indicating that contents of the
>  				  NVDIMM have been scrubbed.
> -		* "locked"	: Indicating that NVDIMM contents cant
> +		* "locked"
> +				  Indicating that NVDIMM contents cant
>  				  be modified until next power cycle.
>  
>  What:		/sys/bus/nd/devices/nmemX/papr/perf_stats
> @@ -51,4 +58,4 @@ Description:
>  		* "MedWDur " : Media Write Duration
>  		* "CchRHCnt" : Cache Read Hit Count
>  		* "CchWHCnt" : Cache Write Hit Count
> -		* "FastWCnt" : Fast Write Count
> \ No newline at end of file
> +		* "FastWCnt" : Fast Write Count
<snip>

Thanks,

I am fine with proposed changes to sysfs-bus-papr-pmem.

Acked-by: Vaibhav Jain <vaibhav@...ux.ibm.com> # for sysfs-bus-papr-pmem