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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <65f3a0e6567a4_7702a294e5@dwillia2-xfh.jf.intel.com.notmuch>
Date: Thu, 14 Mar 2024 18:14:14 -0700
From: Dan Williams <dan.j.williams@...el.com>
To: Stephen Rothwell <sfr@...b.auug.org.au>, Dan Williams
	<dan.j.williams@...el.com>
CC: Ben Cheatham <Benjamin.Cheatham@....com>, Linux Kernel Mailing List
	<linux-kernel@...r.kernel.org>, Linux Next Mailing List
	<linux-next@...r.kernel.org>, <corbet@....net>
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 <dan.j.williams@...el.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@....net>
Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Closes: http://lore.kernel.org/r/20240314141313.7ba04aff@canb.auug.org.au
Cc: Ben Cheatham <Benjamin.Cheatham@....com>
Signed-off-by: Dan Williams <dan.j.williams@...el.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@...r.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