]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
cleanup: Fix documentation build error for ACQUIRE updates
authorDan Williams <dan.j.williams@intel.com>
Thu, 17 Jul 2025 16:30:36 +0000 (09:30 -0700)
committerDave Jiang <dave.jiang@intel.com>
Fri, 18 Jul 2025 02:59:02 +0000 (19:59 -0700)
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>
Link: https://patch.msgid.link/20250717163036.1275791-1-dan.j.williams@intel.com
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
include/linux/cleanup.h

index 4eb83dd71cfeda751c5fdf785d7f03cfa648efc6..0fb796db481192842bbe539893bea06f3977e039 100644 (file)
@@ -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))
  *     ...