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

From: Vaibhav Jain <vaibhav@linux.ibm.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: "Andrew Lunn" <andrew@lunn.ch>, "Peter Chen" <peter.chen@nxp.com>,
	"Linus Walleij" <linus.walleij@linaro.org>,
	"Jerry Snitselaar" <jsnitsel@redhat.com>,
	dri-devel@lists.freedesktop.org, "Pavel Machek" <pavel@ucw.cz>,
	"Christian Gromm" <christian.gromm@microchip.com>,
	ceph-devel@vger.kernel.org,
	"Kan Liang" <kan.liang@linux.intel.com>,
	"Bart Van Assche" <bvanassche@acm.org>,
	linux-acpi@vger.kernel.org,
	"Danil Kipnis" <danil.kipnis@cloud.ionos.com>,
	"Samuel Thibault" <samuel.thibault@ens-lyon.org>,
	"Guenter Roeck" <linux@roeck-us.net>,
	"Ohad Ben-Cohen" <ohad@wizery.com>,
	linux-pm@vger.kernel.org,
	"Simon Gaiser" <simon@invisiblethingslab.com>,
	"Avri Altman" <avri.altman@wdc.com>,
	"Alexander Antonov" <alexander.antonov@linux.intel.com>,
	"Dan Murphy" <dmurphy@ti.com>,
	"Thomas Gleixner" <tglx@linutronix.de>,
	"Stefan Achatz" <erazor_de@users.sourceforge.net>,
	"Konstantin Khlebnikov" <koct9i@gmail.com>,
	"Mathieu Malaterre" <malat@debian.org>,
	"Jingoo Han" <jingoohan1@gmail.com>,
	"Rafael J. Wysocki" <rjw@rjwysocki.net>,
	linux-kernel@vger.kernel.org,
	"Hans Verkuil" <hverkuil-cisco@xs4all.nl>,
	"Andrew Morton" <akpm@linux-foundation.org>,
	"Wu Hao" <hao.wu@intel.com>,
	"Peter Meerwald-Stadler" <pmeerw@pmeerw.net>,
	"Mimi Zohar" <zohar@linux.ibm.com>,
	"Srinivas Kandagatla" <srinivas.kandagatla@linaro.org>,
	"Hanjun Guo" <guohanjun@huawei.com>,
	"Oleh Kravchenko" <oleg@kaa.org.ua>,
	"Lars-Peter Clausen" <lars@metafoo.de>,
	"Andy Shevchenko" <andriy.shevchenko@intel.com>,
	"Saravana Kannan" <saravanak@google.com>,
	"Gregory CLEMENT" <gregory.clement@bootlin.com>,
	"Anton Vorontsov" <anton@enomsg.org>,
	"Marek Marczykowski-Górecki" <marmarek@invisiblethingslab.com>,
	linux-stm32@st-md-mailman.stormreply.com,
	"Bartosz Golaszewski" <bgolaszewski@baylibre.com>,
	"Len Brown" <lenb@kernel.org>,
	"Alexandre Torgue" <alexandre.torgue@st.com>,
	"Michael Hennerich" <Michael.Hennerich@analog.com>,
	"Suzuki K Poulose" <suzuki.poulose@arm.com>,
	coresight@lists.linaro.org, linux-media@vger.kernel.org,
	Frederic@d06av26.portsmouth.uk.ibm.com,
	"Barrat <fbarrat"@linux.ibm.com
Subject: Re: [PATCH 30/33] docs: ABI: cleanup several ABI documents
Date: Fri, 30 Oct 2020 12:03:03 +0530	[thread overview]
Message-ID: <87k0v8jk9s.fsf@vajain21.in.ibm.com> (raw)
In-Reply-To: <95ef2cf3a58f4e50f17d9e58e0d9440ad14d0427.1603893146.git.mchehab+huawei@kernel.org>

Mauro Carvalho Chehab <mchehab+huawei@kernel.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@kernel.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@linux.ibm.com> # for sysfs-bus-papr-pmem