From: Utkarsh Tripathi <utripathi2002@gmail.com>
To: tj@kernel.org, jiangshanlai@gmail.com, skhan@linuxfoundation.org
Cc: Utkarsh Tripathi <utripathi2002@gmail.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH] Sphinx error fixed for inline literal end-string in include/linux/workqueue.h
Date: Wed, 1 May 2024 19:02:40 +0530 [thread overview]
Message-ID: <20240501133240.6003-1-utripathi2002@gmail.com> (raw)
Fixed Error in Workqueue Documentation in the kernel-doc comment
for alloc_workqueue function in include/linux/workqueue.h,
the error was "Inline literal start-string without end-string"
which was fixed by removing the inline literal.
Kernel Version - 6.9.0-rc5
Signed-off-by: Utkarsh Tripathi <utripathi2002@gmail.com>
---
include/linux/workqueue.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
index 158784dd189a..b4aebd981a23 100644
--- a/include/linux/workqueue.h
+++ b/include/linux/workqueue.h
@@ -490,7 +490,7 @@ void workqueue_softirq_dead(unsigned int cpu);
* min_active which is set to min(@max_active, %WQ_DFL_MIN_ACTIVE). This means
* that the sum of per-node max_active's may be larger than @max_active.
*
- * For detailed information on %WQ_* flags, please refer to
+ * For detailed information on WQ_* flags, please refer to
* Documentation/core-api/workqueue.rst.
*
* RETURNS:
--
2.34.1
next reply other threads:[~2024-05-01 13:33 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-01 13:32 Utkarsh Tripathi [this message]
2024-05-01 15:05 ` [PATCH] Sphinx error fixed for inline literal end-string in include/linux/workqueue.h Akira Yokosawa
2024-05-01 17:57 ` [PATCH v2] Sphinx error fixed for inline literal end-string by changing $type_constant2 in kernel-doc script to include "*" unicode character in highlights_rst Utkarsh Tripathi
2024-05-01 18:57 ` Jonathan Corbet
2024-05-02 10:39 ` Akira Yokosawa
2024-05-01 18:05 ` Utkarsh Tripathi
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=20240501133240.6003-1-utripathi2002@gmail.com \
--to=utripathi2002@gmail.com \
--cc=jiangshanlai@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=tj@kernel.org \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).