docs: ABI: sysfs-bus-nvdimm: correct indentations
PATCH 1/1 docs: ABI: sysfs-bus-nvdimm: correct indentations
The identations from line 1 to 4 within sysfs-bus-nvdimm were wrongly incompatible with the indentations of the following contents. Hence correct them.
Discovered when I was executing "make htmldocs" and received the following stderr output:
/<... root dir ...>/Documentation/ABI/testing/sysfs-bus-nvdimm:11: WARNING: Unexpected indentation.
--- Documentation/ABI/testing/sysfs-bus-nvdimm | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/ABI/testing/sysfs-bus-nvdimm +4 -4
@@ -1,7 +1,7 @@ -What: nvdimm -Date: July 2020 -KernelVersion: 5.8 -Contact: Dan Williams <[email protected]> +What: nvdimm +Date: July 2020 +KernelVersion: 5.8 +Contact: Dan Williams <[email protected]> Description: The libnvdimm sub-system implements a common sysfs interface for
Signature · 1 line
2.34.1
Jonathan Corbet
maintainerQuoted 19 lines · Hu Haowen
The identations from line 1 to 4 within sysfs-bus-nvdimm were wrongly incompatible with the indentations of the following contents. Hence correct them.
Discovered when I was executing "make htmldocs" and received the following stderr output:
/<... root dir ...>/Documentation/ABI/testing/sysfs-bus-nvdimm:11: WARNING: Unexpected indentation.
Signed-off-by Hu Haowen <[email protected]>--- Documentation/ABI/testing/sysfs-bus-nvdimm | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)Documentation/ABI/testing/sysfs-bus-nvdimm +0
-0
Documentation/ABI/testing/sysfs-bus-nvdimm line 5
Quoted 9 lines
Documentation/ABI/testing/sysfs-bus-nvdimm +4
-4@@ -1,7 +1,7 @@ -What: nvdimm -Date: July 2020 -KernelVersion: 5.8 -Contact: Dan Williams <[email protected]> +What: nvdimm +Date: July 2020 +KernelVersion: 5.8 +Contact: Dan Williams <[email protected]> Description:
There's only one little problem ... that's not where the error was, so this change doesn't actually make the warning go away.
I've committed the following instead.
Thanks,
jon
docs: ABI: fix an RST error in sysfs-bus-nvdimm
The literal blocks in this file lacked the necessary blank line at the top, causing Sphinx to complain:
/Documentation/ABI/testing/sysfs-bus-nvdimm:11: WARNING: Unexpected indentation.
Add the lines it's longing for and bring about a bit of warning peace.
--- Documentation/ABI/testing/sysfs-bus-nvdimm | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-bus-nvdimm +3 -1
@@ -18,10 +18,12 @@ Description: (RO) Attribute group to describe the magic bits Each attribute under this group defines a bit range of the perf_event_attr.config. Supported attribute is listed below:: + event = "config:0-4" - event ID For example:: - ctl_res_cnt = "event=0x1" + + ctl_res_cnt = "event=0x1" What: /sys/bus/event_source/devices/nmemX/events Date: February 2022
Signature · 1 line
2.41.0