Skip to content

Commit

Permalink
Documentation/ABI/testing/debugfs-cxl: Fix "Unexpected indentation"
Browse files Browse the repository at this point in the history
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: 8039804 ("cxl/core: Add CXL EINJ debugfs files")
Cc: Jonathan Corbet <[email protected]>
Reported-by: Stephen Rothwell <[email protected]>
Closes: https://lore.kernel.org/r/[email protected]
Cc: Ben Cheatham <[email protected]>
Signed-off-by: Dan Williams <[email protected]>
  • Loading branch information
djbw committed Mar 15, 2024
1 parent 8039804 commit edc1243
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion Documentation/ABI/testing/debugfs-cxl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit edc1243

Please sign in to comment.