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

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <4c4ff0ea-509a-4e33-b5b5-ddf6e7213474@gmail.com>
Date: Mon, 26 May 2025 23:23:40 +0300
From: Khaled Elnaggar <khaledelnaggarlinux@...il.com>
To: Matthew Wilcox <willy@...radead.org>
Cc: linux-doc@...r.kernel.org, linux-kernel-mentees@...ts.linux.dev,
 shuah@...nel.org, corbet@....net, masahiroy@...nel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: escape literal asterisk to fix reST emphasis
 warning

On 26/05/2025 10:35 pm, Matthew Wilcox wrote:
> 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
>>
>>

That even looks better in rendered, (::) are actually so prevalent I don't know
how I did not see it before. I will send v2, thank you for the proper fix.