From: Jonathan Corbet <corbet@lwn.net>
To: David Reaver <me@davidreaver.com>
Cc: Dave Jiang <dave.jiang@intel.com>,
Dan Williams <dan.j.williams@intel.com>,
Jonathan Cameron <Jonathan.Cameron@huawei.com>,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
David Reaver <me@davidreaver.com>
Subject: Re: [PATCH] docs: ABI: sysfs-bus-nvdimm: fix unexpected indentation error
Date: Thu, 27 Jul 2023 09:30:10 -0600 [thread overview]
Message-ID: <87o7jx5q4d.fsf@meer.lwn.net> (raw)
In-Reply-To: <20230727152234.86923-1-me@davidreaver.com>
David Reaver <me@davidreaver.com> 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@davidreaver.com>
> ---
> 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
next prev parent reply other threads:[~2023-07-27 15:30 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-27 15:22 [PATCH] docs: ABI: sysfs-bus-nvdimm: fix unexpected indentation error David Reaver
2023-07-27 15:30 ` Jonathan Corbet [this message]
2023-07-27 15:36 ` David Reaver
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87o7jx5q4d.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=Jonathan.Cameron@huawei.com \
--cc=dan.j.williams@intel.com \
--cc=dave.jiang@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=me@davidreaver.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.