Re: [PATCH] docs: escape literal asterisk to fix reST emphasis warning

From: Matthew Wilcox
Date: Mon May 26 2025 - 15:35:38 EST


On Mon, May 26, 2025 at 09:43:59PM +0300, Khaled Elnaggar wrote:
> Escaped a literal '*' character in symbol-namespaces.rst to prevent
> a Docutils warning about unmatched emphasis markers during documentation build.

I don't think this is the right way to fix this problem. We want
the test to work in both rendered and un-rendered form. I think
we can do something like:

-For example:
+For example::

to turn it into a block that is rendered literally. See

For example::

echo $((100 * `cat active_duration` / `cat connected_duration`))

as an example in Documentation/ABI/stable/sysfs-bus-usb

> For example:
>
> - EXPORT_SYMBOL_GPL_FOR_MODULES(preempt_notifier_inc, "kvm,kvm-*")
> + EXPORT_SYMBOL_GPL_FOR_MODULES(preempt_notifier_inc, "kvm,kvm-\*")
>
> will limit usage of this symbol to modules whoes name matches the given
> patterns.
> --
> 2.47.2
>
>