[PATCH] module: Wrap EXPORT_SYMBOL_GPL_FOR_MODULES() example in literal code block

[PATCH] module: Wrap EXPORT_SYMBOL_GPL_FOR_MODULES() example in literal code block

[Bagas Sanjaya]

Stephen Rothwell reports htmldocs warning:

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

Fix the warning by wrapping EXPORT_SYMBOL_GPL_FOR_MODULES() example in
literal code block, just like other examples in symbol namespaces
documentation.

Fixes: 707f853d7fa3 ("module: Provide EXPORT_SYMBOL_GPL_FOR_MODULES() helper")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20250526180350.06b825de@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 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 f7cfa7b73e974d..32fc73dc5529e8 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-*")
 

base-commit: 85c4f3d89b17f569e9b718df6b6e19d6081f01c7
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] module: Wrap EXPORT_SYMBOL_GPL_FOR_MODULES() example in literal code block

[Petr Pavlu]

On 6/4/25 2:51 AM, Bagas Sanjaya wrote:
> Stephen Rothwell reports htmldocs warning:
> 
> Documentation/core-api/symbol-namespaces.rst:90: WARNING: Inline emphasis start-string without end-string. [docutils]
> 
> Fix the warning by wrapping EXPORT_SYMBOL_GPL_FOR_MODULES() example in
> literal code block, just like other examples in symbol namespaces
> documentation.
> 
> Fixes: 707f853d7fa3 ("module: Provide EXPORT_SYMBOL_GPL_FOR_MODULES() helper")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20250526180350.06b825de@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

An earlier patch for the problem was sent in
https://lore.kernel.org/all/20250526211039.163449-1-khaledelnaggarlinux@gmail.com/.

The fix should go through the kbuild tree as the problem currently
originates on its for-next branch.

-- 
Thanks,
Petr

Re: [PATCH] module: Wrap EXPORT_SYMBOL_GPL_FOR_MODULES() example in literal code block

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1126 bytes --]

On Wed, Jun 04, 2025 at 11:10:07AM +0200, Petr Pavlu wrote:
> On 6/4/25 2:51 AM, Bagas Sanjaya wrote:
> > Stephen Rothwell reports htmldocs warning:
> > 
> > Documentation/core-api/symbol-namespaces.rst:90: WARNING: Inline emphasis start-string without end-string. [docutils]
> > 
> > Fix the warning by wrapping EXPORT_SYMBOL_GPL_FOR_MODULES() example in
> > literal code block, just like other examples in symbol namespaces
> > documentation.
> > 
> > Fixes: 707f853d7fa3 ("module: Provide EXPORT_SYMBOL_GPL_FOR_MODULES() helper")
> > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> > Closes: https://lore.kernel.org/linux-next/20250526180350.06b825de@canb.auug.org.au/
> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> 
> An earlier patch for the problem was sent in
> https://lore.kernel.org/all/20250526211039.163449-1-khaledelnaggarlinux@gmail.com/.
> 
> The fix should go through the kbuild tree as the problem currently
> originates on its for-next branch.

OK, thanks! I didn't see Khaled's patch as I was in hurry...

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]