Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Jonathan Corbet <corbet@lwn.net>
To:     Hu Haowen <src.res.211@gmail.com>, dan.j.williams@intel.com,
        dave.jiang@intel.com, Jonathan.Cameron@huawei.com,
        hdegoede@redhat.com
Cc:     Hu Haowen <src.res.211@gmail.com>, linux-kernel@vger.kernel.org,
        linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: ABI: sysfs-bus-nvdimm: correct indentations
In-Reply-To: <20230716161443.1375-1-src.res.211@gmail.com>
References: <20230716161443.1375-1-src.res.211@gmail.com>
Date:   Fri, 21 Jul 2023 14:47:35 -0600
Message-ID: <87h6pxc7q0.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk

Hu Haowen <src.res.211@gmail.com> writes:

> 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 <src.res.211@gmail.com>
> ---
>  Documentation/ABI/testing/sysfs-bus-nvdimm | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-nvdimm b/Documentation/ABI/testing/sysfs-bus-nvdimm
> index de8c5a59c77f..8d048f8e3c39 100644
> --- a/Documentation/ABI/testing/sysfs-bus-nvdimm
> +++ b/Documentation/ABI/testing/sysfs-bus-nvdimm
> @@ -1,7 +1,7 @@
> -What:          nvdimm
> -Date:          July 2020
> -KernelVersion: 5.8
> -Contact:       Dan Williams <dan.j.williams@intel.com>
> +What:           nvdimm
> +Date:           July 2020
> +KernelVersion:  5.8
> +Contact:        Dan Williams <dan.j.williams@intel.com>
>  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.

Reported-by: Hu Haowen <src.res.211@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/ABI/testing/sysfs-bus-nvdimm | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-nvdimm b/Documentation/ABI/testing/sysfs-bus-nvdimm
index de8c5a59c77f..64eb8f4c6a41 100644
--- a/Documentation/ABI/testing/sysfs-bus-nvdimm
+++ b/Documentation/ABI/testing/sysfs-bus-nvdimm
@@ -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
-- 
2.41.0