cleanup: Fix documentation build error for ACQUIRE updates

[PATCH] cleanup: Fix documentation build error for ACQUIRE updates

Posted by Dan Williams 6 months, 3 weeks ago

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

Re: [PATCH] cleanup: Fix documentation build error for ACQUIRE updates

Posted by Randy Dunlap 6 months, 3 weeks ago


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

Re: [PATCH] cleanup: Fix documentation build error for ACQUIRE updates

Posted by Dave Jiang 6 months, 3 weeks ago


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