Re: [PATCH] docs: ABI: sysfs-bus-nvdimm: fix unexpected indentation error

From: Jonathan Corbet
Date: Thu Jul 27 2023 - 11:30:18 EST


David Reaver <me@xxxxxxxxxxxxxxx> writes:

> Fix the following error when running make htmldocs:
>
> Documentation/ABI/testing/sysfs-bus-nvdimm:10: ERROR: Unexpected indentation.
>
> This is caused by missing newlines before the code examples. In particular,
> before this patch, the second example for ctl_res_cnt doesn't render properly.
>
> Link: https://docs.kernel.org/admin-guide/abi-testing.html#abi-sys-bus-event-source-devices-nmemx-format
>
> Signed-off-by: David Reaver <me@xxxxxxxxxxxxxxx>
> ---
> Documentation/ABI/testing/sysfs-bus-nvdimm | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-nvdimm b/Documentation/ABI/testing/sysfs-bus-nvdimm
> index de8c5a59c77f..8564a0ff0d3e 100644
> --- a/Documentation/ABI/testing/sysfs-bus-nvdimm
> +++ b/Documentation/ABI/testing/sysfs-bus-nvdimm
> @@ -18,7 +18,9 @@ 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"
>
> What: /sys/bus/event_source/devices/nmemX/events

Thanks for the patch. This problem is already fixed in docs-next,
though, and thus in linux-next as well.

jon