public inbox for linux-kernel-mentees@lists.linux-foundation.org
 help / color / mirror / Atom feed
From: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
To: Matthew Wilcox <willy@infradead.org>
Cc: linux-doc@vger.kernel.org, linux-kernel-mentees@lists.linux.dev,
	shuah@kernel.org, corbet@lwn.net, masahiroy@kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: escape literal asterisk to fix reST emphasis warning
Date: Mon, 26 May 2025 23:23:40 +0300	[thread overview]
Message-ID: <4c4ff0ea-509a-4e33-b5b5-ddf6e7213474@gmail.com> (raw)
In-Reply-To: <aDTCdQNUN4Zlw2jJ@casper.infradead.org>

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.


  reply	other threads:[~2025-05-26 20:23 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-26 18:43 [PATCH] docs: escape literal asterisk to fix reST emphasis warning Khaled Elnaggar
2025-05-26 19:35 ` Matthew Wilcox
2025-05-26 20:23   ` Khaled Elnaggar [this message]
2025-05-26 21:10 ` [PATCH v2] docs: symbol-namespaces: fix reST warning with literal block Khaled Elnaggar
2025-06-04  9:16   ` Bagas Sanjaya
2025-06-05 19:38   ` Masahiro Yamada

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4c4ff0ea-509a-4e33-b5b5-ddf6e7213474@gmail.com \
    --to=khaledelnaggarlinux@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linux.dev \
    --cc=linux-kernel@vger.kernel.org \
    --cc=masahiroy@kernel.org \
    --cc=shuah@kernel.org \
    --cc=willy@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox