Documentation/ABI/testing/debugfs-cxl: Fix "Unexpected indentation"
authorDan Williams <dan.j.williams@intel.com>
Fri, 15 Mar 2024 00:34:26 +0000 (17:34 -0700)
committerDan Williams <dan.j.williams@intel.com>
Fri, 15 Mar 2024 00:34:26 +0000 (17:34 -0700)
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

index 4c0f62f..c61f9b8 100644 (file)
@@ -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