From: SJ Park <sj@kernel.org>
To: Jani Nikula <jani.nikula@intel.com>
Cc: SJ Park <sj@kernel.org>, Manuel Ebner <manuelebnerli@mailbox.org>,
Jonathan Corbet <corbet@lwn.net>,
Shuah Khan <skhan@linuxfoundation.org>,
workflows@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: deprecated.rst: add to syntax highlighting
Date: Wed, 9 Sep 2026 17:11:17 -0700 [thread overview]
Message-ID: <20260910001117.109969-1-sj@kernel.org> (raw)
In-Reply-To: <d35909dea037d1ac5c6a919bf1a7d53d8d5fddb4@intel.com>
On Wed, 09 Sep 2026 20:00:47 +0300 Jani Nikula <jani.nikula@intel.com> wrote:
> On Wed, 09 Sep 2026, Manuel Ebner <manuelebnerli@mailbox.org> wrote:
> > Mark key words 'gfp' and 'GFP_KERNEL' for syntax-highlighting.
> >
> > Suggested-by: SJ Park <sj@kernel.org>
> > Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
> > ---
> > Suggestion:
> > https://lore.kernel.org/all/20260430010332.114100-1-sj@kernel.org/
> > ---
> > Documentation/process/deprecated.rst | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/process/deprecated.rst b/Documentation/process/deprecated.rst
> > index 22a5e62c9..4d4d29b97 100644
> > --- a/Documentation/process/deprecated.rst
> > +++ b/Documentation/process/deprecated.rst
> > @@ -404,7 +404,7 @@ become, respectively::
> > ptr = kmalloc_flex(*ptr, flex_member, count [, gfp] );
> > __auto_type ptr = kmalloc_obj(struct foo [, gfp] );
> >
> > -The argument gfp is optional, the default value is GFP_KERNEL.
> > +The argument `gfp` is optional, the default value is `GFP_KERNEL`.
> > If `ptr->flex_member` is annotated with __counted_by(), the allocation
> > will automatically fail if `count` is larger than the maximum
> > representable value that can be stored in the counter member associated
>
> Single backquotes in rst mean "interpreted text" [1], not markdown style
> code.
Because multiple other parts in the doc are using single backquotes, I feel
this patch is improving the consistency. Using double backquotes would also be
nice. I have no strong opinion here.
Thanks,
SJ
[...]
prev parent reply other threads:[~2026-09-10 0:11 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-09 14:12 Manuel Ebner
2026-09-09 14:25 ` SJ Park
2026-09-09 16:14 ` Kees Cook
2026-09-10 0:09 ` SJ Park
2026-09-09 17:00 ` Jani Nikula
2026-09-10 0:11 ` SJ Park [this message]
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=20260910001117.109969-1-sj@kernel.org \
--to=sj@kernel.org \
--cc=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=manuelebnerli@mailbox.org \
--cc=skhan@linuxfoundation.org \
--cc=workflows@vger.kernel.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
all inboxes | Powered by JetHome®