docs: symbol-namespaces: fix reST warning with literal block

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

Posted by Khaled Elnaggar 8 months, 2 weeks ago

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

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

Posted by Masahiro Yamada 8 months, 1 week ago

On Tue, May 27, 2025 at 6:10 AM Khaled Elnaggar
<khaledelnaggarlinux@gmail.com> wrote:
>
> 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.
>
> --



Applied to linux-kbuild.
Thanks.

-- 
Best Regards
Masahiro Yamada

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

Posted by Bagas Sanjaya 8 months, 1 week ago

On Tue, May 27, 2025 at 12:10:39AM +0300, Khaled Elnaggar wrote:
> 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-*")
> 
 
LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

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