linux-kernel - [PATCH v2] docs: symbol-namespaces: fix reST warning with literal block

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20250526211039.163449-1-khaledelnaggarlinux@gmail.com>
Date: Tue, 27 May 2025 00:10:39 +0300
From: Khaled Elnaggar <khaledelnaggarlinux@...il.com>
To: linux-doc@...r.kernel.org
Cc: willy@...radead.org,
	linux-kernel-mentees@...ts.linux.dev,
	shuah@...nel.org,
	corbet@....net,
	linux-kernel@...r.kernel.org,
	masahiroy@...nel.org,
	Khaled Elnaggar <khaledelnaggarlinux@...il.com>
Subject: [PATCH v2] docs: symbol-namespaces: fix reST warning with literal block

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@...il.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