From: Dan Williams <dan.j.williams@intel.com>
To: Stephen Rothwell <sfr@canb.auug.org.au>,
Dan Williams <dan.j.williams@intel.com>
Cc: Ben Cheatham <Benjamin.Cheatham@amd.com>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Next Mailing List <linux-next@vger.kernel.org>,
<corbet@lwn.net>
Subject: RE: linux-next: build warning after merge of the cxl tree
Date: Thu, 14 Mar 2024 18:14:14 -0700 [thread overview]
Message-ID: <65f3a0e6567a4_7702a294e5@dwillia2-xfh.jf.intel.com.notmuch> (raw)
In-Reply-To: <20240314141313.7ba04aff@canb.auug.org.au>
Stephen Rothwell wrote:
> Hi all,
>
> After merging the cxl tree, today's linux-next build (htmldocs) produced
> this warning:
>
> Documentation/ABI/testing/debugfs-cxl:38: ERROR: Unexpected indentation.
>
> Introduced by commit
>
> 8039804cfa73 ("cxl/core: Add CXL EINJ debugfs files")
Thanks for this report. So, Sphinx errors are not fun to debug. I took a lot of
fiddling to figure out that Sphinx really had the problem several lines down,
but was considering everything after the "What:" line as a single block staring
at line 38.
By trial and error this change made it happy:
-- 8< --
From edc1243437e75ea019ba264d38b2cd793ae83ed0 Mon Sep 17 00:00:00 2001
From: Dan Williams <dan.j.williams@intel.com>
Date: Thu, 14 Mar 2024 17:34:26 -0700
Subject: [PATCH] Documentation/ABI/testing/debugfs-cxl: Fix "Unexpected
indentation"
Stephen reported that an htmldocs build hit:
Documentation/ABI/testing/debugfs-cxl:38: ERROR: Unexpected indentation.
It turns out that line was fine but the tool was unhappy about some line
breaks in the table of values to error types.
It turns out that:
make V=1 SPHINXDIRS="admin-guide" htmldocs
...can not be used to get more info about what is behind a documentation
build error. It was only pure luck that reflowing the text resulted in
an error message that seemed a imply a problem later on with line breaks
around the table.
Fixes: 8039804cfa73 ("cxl/core: Add CXL EINJ debugfs files")
Cc: Jonathan Corbet <corbet@lwn.net>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: http://lore.kernel.org/r/20240314141313.7ba04aff@canb.auug.org.au
Cc: Ben Cheatham <Benjamin.Cheatham@amd.com>
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
---
Documentation/ABI/testing/debugfs-cxl | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/Documentation/ABI/testing/debugfs-cxl b/Documentation/ABI/testing/debugfs-cxl
index 4c0f62f881ca..c61f9b813973 100644
--- a/Documentation/ABI/testing/debugfs-cxl
+++ b/Documentation/ABI/testing/debugfs-cxl
@@ -40,8 +40,12 @@ KernelVersion: v6.9
Contact: linux-cxl@vger.kernel.org
Description:
(RO) Prints the CXL protocol error types made available by
- the platform in the format "0x<error number> <error type>".
+ the platform in the format:
+
+ 0x<error number> <error type>
+
The possible error types are (as of ACPI v6.5):
+
0x1000 CXL.cache Protocol Correctable
0x2000 CXL.cache Protocol Uncorrectable non-fatal
0x4000 CXL.cache Protocol Uncorrectable fatal
--
2.44.0
next prev parent reply other threads:[~2024-03-15 1:14 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-14 3:13 linux-next: build warning after merge of the cxl tree Stephen Rothwell
2024-03-15 1:14 ` Dan Williams [this message]
-- strict thread matches above, loose matches on Subject: below --
2023-10-30 5:05 Stephen Rothwell
2021-05-20 6:03 Stephen Rothwell
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=65f3a0e6567a4_7702a294e5@dwillia2-xfh.jf.intel.com.notmuch \
--to=dan.j.williams@intel.com \
--cc=Benjamin.Cheatham@amd.com \
--cc=corbet@lwn.net \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).