Received-SPF: pass (google.com: domain of linux-kernel+bounces-103953-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Date: Thu, 14 Mar 2024 18:14:14 -0700
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
Message-ID: <65f3a0e6567a4_7702a294e5@dwillia2-xfh.jf.intel.com.notmuch>
References: <20240314141313.7ba04aff@canb.auug.org.au>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20240314141313.7ba04aff@canb.auug.org.au>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?CcaVZnc0SqmcnjyejZapE130A/4h13/IN2mM3lwxd/p4/IGLOha87Clx6dH3?=
 =?us-ascii?Q?rsJoQOvCq0QWcwSgspC6yfLynp5HmxNkdmWb+O/Dw4oSyr/7gk9imY/M6WG3?=
 =?us-ascii?Q?9JtbFRGsAE3haEDt4GXe2CffxqC4Hx5ErApT1XxZV/eUAWc/Ot6IZGH/33o8?=
 =?us-ascii?Q?jRKEdhhwpnUQ1F9k/CcuDWPoKtxg9gIKmIlB8bZ1W1iPcyYnz7KNgkuMVHLy?=
 =?us-ascii?Q?SyN8jWsJ7bOQEKYI0iQZgOPfo13uhD9UfbU9O4zsMhTU1IbIrnqd2sCMvb5X?=
 =?us-ascii?Q?rNqlGibEgK0JgOLwZ61HSEsJQKkEKJzBjDy64crw8muNv/d0UzOOLTo7zD61?=
 =?us-ascii?Q?bzxSPxw4YEwrD+A5887F7XJMxL2pCkB+3FBdWIG75v09DNOHK6metmpQjwXi?=
 =?us-ascii?Q?D26uhlG8XsYA4eirQRUUcexO3XdOVY5oridN4ly0n6D5J/G5hXBawR70UsH8?=
 =?us-ascii?Q?UmdZO9jTKrcKYdZePQ9+ZGi9ariF3Im1Nqm35YJPf0fSrLId0fR4couEZY17?=
 =?us-ascii?Q?O3Juxs3/m940vKdRQ+umjy3EVz0W5aqe0T9Ov+Xn6ZrkuB1WcEp3WF2HRa5B?=
 =?us-ascii?Q?ASnY3EpR5rjmyvrNSNehq/XPA0m60SNt4jWrPI/bTi4TvqfRvrCYEF92l9gv?=
 =?us-ascii?Q?QfR/lYpMrmtbIY4AzidFDuXWqSwiOLDB67RWY7PQ8Pt877qUVOYZAN3RUdg1?=
 =?us-ascii?Q?WLLcxwHKJlJB4BhW7AHSEUMVsKENut3nCvqwlst2XrjXjEiJZ5gSt8+9uZEI?=
 =?us-ascii?Q?nZ7CY4qIukNE9Q3rrSJlRTKKOib72SgAU2JH9QoXqMn4MVuwklnGmzg49Fco?=
 =?us-ascii?Q?TteZGrTgxFPEUJxqgiSoWVuJjlUSHIXvvvizDUPB/h0HHbpl4TLZOjsAqmt6?=
 =?us-ascii?Q?nl2FLEAfsbGiM/aKmSZQfkZXZIrhuvRbwdZ8btwLzUQKrD8V0Jo54I/AxjHN?=
 =?us-ascii?Q?ty+hDt7XHoovxEYIc3RBzdUtQpLzis+xHsCmQfeH/z3cjBFIT3FiRp7uijCe?=
 =?us-ascii?Q?Y5eCo69GFNkfGobHwvtfonudEdqXvnUx4GgMNgKL0G6Ogp5olaTZmE1khecl?=
 =?us-ascii?Q?gAaNRDo9eroVUqny9qGTt91z3usBp2ayq6dVqs+g5O7c5/RFwU4I7DZtvd77?=
 =?us-ascii?Q?pR0rW6xmQGXh0Pw4FTELOJuMpHsHC28NQFxbbaJsQDuEwuOLQEHnMjB4WX+K?=
 =?us-ascii?Q?HQPcT4y7gUqw0cQK/jzt7xfW2N858kskFpjKU0VV7GfdHzKnJijCb2CEs5kC?=
 =?us-ascii?Q?UfTAGp84MZWwuygTb8hxBhgoUsOEVd/7QmYzvhQZNtzTWZIb0qjUPDOmZ74F?=
 =?us-ascii?Q?kwaAvz5FVt8asF4upNZ0qdNwhbMcQE9PfEnjC0zaNdfphbEh3NNyMuZiSZ9h?=
 =?us-ascii?Q?CZIuIQsn7mKMGwS52D6nBTIXPXeTkWccE3QNJhOcun4tCDWcSqtCxLD/YDwn?=
 =?us-ascii?Q?OyCnrt2XcUMleVYgIcZvp8f3nvQhOaOBzD0Yt/FBl01Y9nSedeSl9jmZuCpK?=
 =?us-ascii?Q?uxE2XDGKgXxUcjV4sNxEx8o1hbDCh5tVuZhDrd/qBX5kYdKPbPwtBAdZxfBE?=
 =?us-ascii?Q?TFJmVE0FIsRYpy4baG4f9+aTmDRmSpSJlY+BmRrq6T1t3c6pG3GYX3tdDU2f?=
 =?us-ascii?Q?LQ=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 0eb67934-9819-46dc-d984-08dc448d4082
X-MS-Exchange-CrossTenant-AuthSource: PH8PR11MB8107.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Mar 2024 01:14:24.5186
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Pchj9I0wHkFIMpxqedb23sDWgj4NVhT/SCYvcPRAMYM5sow80R1SiiWt6Vg0m4MV8R9jOT4meVLm2ffL3Xpn/c71vjXuiCNu+PDImHscldY=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR11MB5205
X-OriginatorOrg: intel.com

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