* linux-next: build warning after merge of the cxl tree
@ 2021-05-20 6:03 Stephen Rothwell
0 siblings, 0 replies; 13+ messages in thread
From: Stephen Rothwell @ 2021-05-20 6:03 UTC (permalink / raw)
To: Dan Williams; +Cc: Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 325 bytes --]
Hi all,
After merging the cxl tree, today's linux-next build (htmldocs)
produced this warning:
Documentation/driver-api/cxl/memory-devices.rst:32: WARNING: Title underline too short.
CXL Core
-------
Introduced by commit
5f653f7590ab ("cxl/core: Rename bus.c to core.c")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread
* linux-next: build warning after merge of the cxl tree
@ 2023-10-30 5:05 Stephen Rothwell
0 siblings, 0 replies; 13+ messages in thread
From: Stephen Rothwell @ 2023-10-30 5:05 UTC (permalink / raw)
To: Dan Williams
Cc: Dave Jiang, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 386 bytes --]
Hi all,
After merging the cxl tree, today's linux-next build (i386 defconfig
and arm64 defconfig) produced this warning:
WARNING: modpost: vmlinux: acpi_parse_entries_array: EXPORT_SYMBOL used for init symbol. Remove __init or EXPORT_SYMBOL.
Introduced by commit
a103f46633fd ("acpi: Move common tables helper functions to common lib")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread
* linux-next: build warning after merge of the cxl tree
@ 2024-03-14 3:13 Stephen Rothwell
2024-03-15 1:14 ` Dan Williams
0 siblings, 1 reply; 13+ messages in thread
From: Stephen Rothwell @ 2024-03-14 3:13 UTC (permalink / raw)
To: Dan Williams
Cc: Ben Cheatham, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 293 bytes --]
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
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread
* RE: linux-next: build warning after merge of the cxl tree
2024-03-14 3:13 Stephen Rothwell
@ 2024-03-15 1:14 ` Dan Williams
0 siblings, 0 replies; 13+ messages in thread
From: Dan Williams @ 2024-03-15 1:14 UTC (permalink / raw)
To: Stephen Rothwell, Dan Williams
Cc: Ben Cheatham, Linux Kernel Mailing List, Linux Next Mailing List,
corbet
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
^ permalink raw reply related [flat|nested] 13+ messages in thread
* linux-next: build warning after merge of the cxl tree
@ 2024-09-12 8:30 Stephen Rothwell
0 siblings, 0 replies; 13+ messages in thread
From: Stephen Rothwell @ 2024-09-12 8:30 UTC (permalink / raw)
To: Dan Williams
Cc: Dave Jiang, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 568 bytes --]
Hi all,
After merging the cxl tree, today's linux-next build (htmldocs) produced
this warning:
drivers/cxl/pci.c:200: warning: Excess function parameter 'mds' description in '__cxl_pci_mbox_send_cmd'
drivers/cxl/pci.c:200: warning: Function parameter or struct member 'cxl_mbox' not described in '__cxl_pci_mbox_send_cmd'
drivers/cxl/pci.c:200: warning: Excess function parameter 'mds' description in '__cxl_pci_mbox_send_cmd'
Introduced by commit
bb10253dafc1 ("cxl: Move mailbox related bits to the same context")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread
* linux-next: build warning after merge of the cxl tree
@ 2025-02-26 4:49 Stephen Rothwell
2025-02-26 16:01 ` Dave Jiang
0 siblings, 1 reply; 13+ messages in thread
From: Stephen Rothwell @ 2025-02-26 4:49 UTC (permalink / raw)
To: Dan Williams
Cc: Dave Jiang, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 455 bytes --]
Hi all,
After merging the cxl tree, today's linux-next build (htmldocs) produced
this warning:
drivers/cxl/cxlmem.h:439: warning: Function parameter or struct member 'cxlfs' not described in 'cxl_dev_state'
drivers/cxl/cxlmem.h:439: warning: Excess struct member 'cxl_features' description in 'cxl_dev_state'
Introduced by commit
7d2bffbd7fb6 ("cxl: Add Get Supported Features command for kernel usage")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: linux-next: build warning after merge of the cxl tree
2025-02-26 4:49 Stephen Rothwell
@ 2025-02-26 16:01 ` Dave Jiang
0 siblings, 0 replies; 13+ messages in thread
From: Dave Jiang @ 2025-02-26 16:01 UTC (permalink / raw)
To: Stephen Rothwell, Dan Williams
Cc: Linux Kernel Mailing List, Linux Next Mailing List
On 2/25/25 9:49 PM, Stephen Rothwell wrote:
> Hi all,
>
> After merging the cxl tree, today's linux-next build (htmldocs) produced
> this warning:
>
> drivers/cxl/cxlmem.h:439: warning: Function parameter or struct member 'cxlfs' not described in 'cxl_dev_state'
> drivers/cxl/cxlmem.h:439: warning: Excess struct member 'cxl_features' description in 'cxl_dev_state'
>
> Introduced by commit
>
> 7d2bffbd7fb6 ("cxl: Add Get Supported Features command for kernel usage")
>
Thanks Stephen. Should be fixed now.
^ permalink raw reply [flat|nested] 13+ messages in thread
* linux-next: build warning after merge of the cxl tree
@ 2025-06-10 4:26 Stephen Rothwell
2025-06-10 15:50 ` Dave Jiang
0 siblings, 1 reply; 13+ messages in thread
From: Stephen Rothwell @ 2025-06-10 4:26 UTC (permalink / raw)
To: Dan Williams
Cc: Dave Jiang, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 390 bytes --]
Hi all,
After merging the cxl tree, today's linux-next build (htmldocs) produced
this warning:
Documentation/driver-api/cxl/index.rst:11: WARNING: toctree contains reference to nonexisting document 'driver-api/cxl/conventions' [toc.not_readable]
Introduced by commit
11f401444201 ("Documentation/driver-api/cxl: Introduce conventions.rst")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: linux-next: build warning after merge of the cxl tree
2025-06-10 4:26 linux-next: build warning after merge of the cxl tree Stephen Rothwell
@ 2025-06-10 15:50 ` Dave Jiang
0 siblings, 0 replies; 13+ messages in thread
From: Dave Jiang @ 2025-06-10 15:50 UTC (permalink / raw)
To: Stephen Rothwell, Dan Williams
Cc: Linux Kernel Mailing List, Linux Next Mailing List
On 6/9/25 9:26 PM, Stephen Rothwell wrote:
> Hi all,
>
> After merging the cxl tree, today's linux-next build (htmldocs) produced
> this warning:
>
> Documentation/driver-api/cxl/index.rst:11: WARNING: toctree contains reference to nonexisting document 'driver-api/cxl/conventions' [toc.not_readable]
>
> Introduced by commit
>
> 11f401444201 ("Documentation/driver-api/cxl: Introduce conventions.rst")
>
s/conventions/conventions.rst/ for the file. I'll fix and re-push.
^ permalink raw reply [flat|nested] 13+ messages in thread
* linux-next: build warning after merge of the cxl tree
@ 2025-07-17 7:33 Stephen Rothwell
2025-07-17 16:30 ` [PATCH] cleanup: Fix documentation build error for ACQUIRE updates Dan Williams
0 siblings, 1 reply; 13+ messages in thread
From: Stephen Rothwell @ 2025-07-17 7:33 UTC (permalink / raw)
To: Dan Williams
Cc: Dave Jiang, Peter Zijlstra, Linux Kernel Mailing List,
Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 499 bytes --]
Hi all,
After merging the cxl tree, today's linux-next build (htmldocs) produced
this warning:
Documentation/core-api/cleanup:7: include/linux/cleanup.h:73: ERROR: Unexpected indentation. [docutils]
Documentation/core-api/cleanup:7: include/linux/cleanup.h:74: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
Introduced by commit
857d18f23ab1 ("cleanup: Introduce ACQUIRE() and ACQUIRE_ERR() for conditional locks")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread
* [PATCH] cleanup: Fix documentation build error for ACQUIRE updates
2025-07-17 7:33 linux-next: build warning after merge of the cxl tree Stephen Rothwell
@ 2025-07-17 16:30 ` Dan Williams
2025-07-17 17:12 ` Dave Jiang
2025-07-18 2:47 ` Randy Dunlap
0 siblings, 2 replies; 13+ messages in thread
From: Dan Williams @ 2025-07-17 16:30 UTC (permalink / raw)
To: dave.jiang; +Cc: linux-kernel, peterz, linux-next, Stephen Rothwell
Stephen reports:
Documentation/core-api/cleanup:7: include/linux/cleanup.h:73: ERROR: Unexpected indentation. [docutils]
Documentation/core-api/cleanup:7: include/linux/cleanup.h:74: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
Which points out that the ACQUIRE() example in cleanup.h missed the "::"
suffix to mark the following text as a code-block.
Fixes: 857d18f23ab1 ("cleanup: Introduce ACQUIRE() and ACQUIRE_ERR() for conditional locks")
Reported-by: Stephen Rothwell <sfr@canb•auug.org.au>
Closes: http://lore.kernel.org/20250717173354.34375751@canb.auug.org.au
Signed-off-by: Dan Williams <dan.j.williams@intel•com>
---
include/linux/cleanup.h | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/include/linux/cleanup.h b/include/linux/cleanup.h
index 4eb83dd71cfe..0fb796db4811 100644
--- a/include/linux/cleanup.h
+++ b/include/linux/cleanup.h
@@ -64,8 +64,7 @@
* the remainder of "func()".
*
* The ACQUIRE() macro can be used in all places that guard() can be
- * used and additionally support conditional locks
- *
+ * used and additionally support conditional locks::
*
* DEFINE_GUARD_COND(pci_dev, _try, pci_dev_trylock(_T))
* ...
base-commit: 857d18f23ab17284d1b6de6f61f4e74958596376
--
2.50.1
^ permalink raw reply related [flat|nested] 13+ messages in thread
* Re: [PATCH] cleanup: Fix documentation build error for ACQUIRE updates
2025-07-17 16:30 ` [PATCH] cleanup: Fix documentation build error for ACQUIRE updates Dan Williams
@ 2025-07-17 17:12 ` Dave Jiang
2025-07-18 2:47 ` Randy Dunlap
1 sibling, 0 replies; 13+ messages in thread
From: Dave Jiang @ 2025-07-17 17:12 UTC (permalink / raw)
To: Dan Williams
Cc: linux-kernel, peterz, linux-next, Stephen Rothwell,
linux-cxl@vger•kernel.org
On 7/17/25 9:30 AM, Dan Williams wrote:
> Stephen reports:
>
> Documentation/core-api/cleanup:7: include/linux/cleanup.h:73: ERROR: Unexpected indentation. [docutils]
> Documentation/core-api/cleanup:7: include/linux/cleanup.h:74: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
>
> Which points out that the ACQUIRE() example in cleanup.h missed the "::"
> suffix to mark the following text as a code-block.
>
> Fixes: 857d18f23ab1 ("cleanup: Introduce ACQUIRE() and ACQUIRE_ERR() for conditional locks")
> Reported-by: Stephen Rothwell <sfr@canb•auug.org.au>
> Closes: http://lore.kernel.org/20250717173354.34375751@canb.auug.org.au
> Signed-off-by: Dan Williams <dan.j.williams@intel•com>
Applied to cxl/next
d07b0029a1734062a14466100165994bef2839cf
> ---
> include/linux/cleanup.h | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/include/linux/cleanup.h b/include/linux/cleanup.h
> index 4eb83dd71cfe..0fb796db4811 100644
> --- a/include/linux/cleanup.h
> +++ b/include/linux/cleanup.h
> @@ -64,8 +64,7 @@
> * the remainder of "func()".
> *
> * The ACQUIRE() macro can be used in all places that guard() can be
> - * used and additionally support conditional locks
> - *
> + * used and additionally support conditional locks::
> *
> * DEFINE_GUARD_COND(pci_dev, _try, pci_dev_trylock(_T))
> * ...
>
> base-commit: 857d18f23ab17284d1b6de6f61f4e74958596376
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: [PATCH] cleanup: Fix documentation build error for ACQUIRE updates
2025-07-17 16:30 ` [PATCH] cleanup: Fix documentation build error for ACQUIRE updates Dan Williams
2025-07-17 17:12 ` Dave Jiang
@ 2025-07-18 2:47 ` Randy Dunlap
1 sibling, 0 replies; 13+ messages in thread
From: Randy Dunlap @ 2025-07-18 2:47 UTC (permalink / raw)
To: Dan Williams, dave.jiang
Cc: linux-kernel, peterz, linux-next, Stephen Rothwell
On 7/17/25 9:30 AM, Dan Williams wrote:
> Stephen reports:
>
> Documentation/core-api/cleanup:7: include/linux/cleanup.h:73: ERROR: Unexpected indentation. [docutils]
> Documentation/core-api/cleanup:7: include/linux/cleanup.h:74: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
>
> Which points out that the ACQUIRE() example in cleanup.h missed the "::"
> suffix to mark the following text as a code-block.
>
> Fixes: 857d18f23ab1 ("cleanup: Introduce ACQUIRE() and ACQUIRE_ERR() for conditional locks")
> Reported-by: Stephen Rothwell <sfr@canb•auug.org.au>
> Closes: http://lore.kernel.org/20250717173354.34375751@canb.auug.org.au
> Signed-off-by: Dan Williams <dan.j.williams@intel•com>
Acked-by: Randy Dunlap <rdunlap@infradead•org>
Tested-by: Randy Dunlap <rdunlap@infradead•org>
Thanks.
> ---
> include/linux/cleanup.h | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/include/linux/cleanup.h b/include/linux/cleanup.h
> index 4eb83dd71cfe..0fb796db4811 100644
> --- a/include/linux/cleanup.h
> +++ b/include/linux/cleanup.h
> @@ -64,8 +64,7 @@
> * the remainder of "func()".
> *
> * The ACQUIRE() macro can be used in all places that guard() can be
> - * used and additionally support conditional locks
> - *
> + * used and additionally support conditional locks::
> *
> * DEFINE_GUARD_COND(pci_dev, _try, pci_dev_trylock(_T))
> * ...
>
> base-commit: 857d18f23ab17284d1b6de6f61f4e74958596376
--
~Randy
^ permalink raw reply [flat|nested] 13+ messages in thread
end of thread, other threads:[~2025-07-18 2:47 UTC | newest]
Thread overview: 13+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-07-17 7:33 linux-next: build warning after merge of the cxl tree Stephen Rothwell
2025-07-17 16:30 ` [PATCH] cleanup: Fix documentation build error for ACQUIRE updates Dan Williams
2025-07-17 17:12 ` Dave Jiang
2025-07-18 2:47 ` Randy Dunlap
-- strict thread matches above, loose matches on Subject: below --
2025-06-10 4:26 linux-next: build warning after merge of the cxl tree Stephen Rothwell
2025-06-10 15:50 ` Dave Jiang
2025-02-26 4:49 Stephen Rothwell
2025-02-26 16:01 ` Dave Jiang
2024-09-12 8:30 Stephen Rothwell
2024-03-14 3:13 Stephen Rothwell
2024-03-15 1:14 ` Dan Williams
2023-10-30 5:05 Stephen Rothwell
2021-05-20 6:03 Stephen Rothwell
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox