linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
To: linux-doc@vger.kernel.org
Cc: willy@infradead.org, linux-kernel-mentees@lists.linux.dev,
	shuah@kernel.org, corbet@lwn.net, linux-kernel@vger.kernel.org,
	masahiroy@kernel.org,
	Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
Subject: [PATCH v2] docs: symbol-namespaces: fix reST warning with literal block
Date: Tue, 27 May 2025 00:10:39 +0300	[thread overview]
Message-ID: <20250526211039.163449-1-khaledelnaggarlinux@gmail.com> (raw)
In-Reply-To: <20250526184401.33417-1-khaledelnaggarlinux@gmail.com>

Use a literal block for the EXPORT_SYMBOL_GPL_FOR_MODULES() example to
avoid a Docutils warning about unmatched '*'. This ensures correct rendering
and keeps the source readable.

Warning:
Documentation/core-api/symbol-namespaces.rst:90: WARNING: Inline emphasis start-string without end-string. [docutils]

Signed-off-by: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
---

Changes in v2:
- Use 'For example::' to create a literal block, suggested by Matthew Wilcox.

---
 Documentation/core-api/symbol-namespaces.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/core-api/symbol-namespaces.rst b/Documentation/core-api/symbol-namespaces.rst
index f7cfa7b73e97..32fc73dc5529 100644
--- a/Documentation/core-api/symbol-namespaces.rst
+++ b/Documentation/core-api/symbol-namespaces.rst
@@ -85,7 +85,7 @@ namespace cannot be imported.
 The macro takes a comma separated list of module names, allowing only those
 modules to access this symbol. Simple tail-globs are supported.

-For example:
+For example::

   EXPORT_SYMBOL_GPL_FOR_MODULES(preempt_notifier_inc, "kvm,kvm-*")

--
2.47.2


  parent reply	other threads:[~2025-05-26 21:10 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-26 18:43 [PATCH] docs: escape literal asterisk to fix reST emphasis warning Khaled Elnaggar
2025-05-26 19:35 ` Matthew Wilcox
2025-05-26 20:23   ` Khaled Elnaggar
2025-05-26 21:10 ` Khaled Elnaggar [this message]
2025-06-04  9:16   ` [PATCH v2] docs: symbol-namespaces: fix reST warning with literal block Bagas Sanjaya
2025-06-05 19:38   ` Masahiro Yamada

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=20250526211039.163449-1-khaledelnaggarlinux@gmail.com \
    --to=khaledelnaggarlinux@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linux.dev \
    --cc=linux-kernel@vger.kernel.org \
    --cc=masahiroy@kernel.org \
    --cc=shuah@kernel.org \
    --cc=willy@infradead.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 NNTP newsgroup(s).