From: Dan Williams <dan.j.williams@intel.com>
To: <dave.jiang@intel.com>
Cc: <linux-kernel@vger.kernel.org>, <peterz@infradead.org>,
<linux-next@vger.kernel.org>,
Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH] cleanup: Fix documentation build error for ACQUIRE updates
Date: Thu, 17 Jul 2025 09:30:36 -0700 [thread overview]
Message-ID: <20250717163036.1275791-1-dan.j.williams@intel.com> (raw)
In-Reply-To: <20250717173354.34375751@canb.auug.org.au>
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
next prev parent reply other threads:[~2025-07-17 16:30 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-17 7:33 linux-next: build warning after merge of the cxl tree Stephen Rothwell
2025-07-17 16:30 ` Dan Williams [this message]
2025-07-17 17:12 ` [PATCH] cleanup: Fix documentation build error for ACQUIRE updates Dave Jiang
2025-07-18 2:47 ` Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250717163036.1275791-1-dan.j.williams@intel.com \
--to=dan.j.williams@intel.com \
--cc=dave.jiang@intel.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=peterz@infradead.org \
--cc=sfr@canb.auug.org.au \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox