2024-03-14 03:13:28

by Stephen Rothwell

[permalink] [raw]

Subject: linux-next: build warning after merge of the cxl tree

---

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")

--
Cheers,
Stephen Rothwell

---

Attachments:

(No filename) (499.00 B)
OpenPGP digital signature

2024-03-15 01:14:38

by Dan Williams

[permalink] [raw]

Subject: RE: linux-next: build warning after merge of the cxl tree

---

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 <[email protected]>
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 <[email protected]>
Reported-by: Stephen Rothwell <[email protected]>
Closes: http://lore.kernel.org/r/[email protected]
Cc: Ben Cheatham <[email protected]>
Signed-off-by: Dan Williams <[email protected]>
---
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: [email protected]
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