Re: [PATCH] Documentation: deprecated.rst: add to syntax highlighting
From: SJ Park
Date: Wed Sep 09 2026 - 20:12:41 EST
On Wed, 09 Sep 2026 20:00:47 +0300 Jani Nikula <jani.nikula@xxxxxxxxx> wrote:
> On Wed, 09 Sep 2026, Manuel Ebner <manuelebnerli@xxxxxxxxxxx> wrote:
> > Mark key words 'gfp' and 'GFP_KERNEL' for syntax-highlighting.
> >
> > Suggested-by: SJ Park <sj@xxxxxxxxxx>
> > Signed-off-by: Manuel Ebner <manuelebnerli@xxxxxxxxxxx>
> > ---
> > Suggestion:
> > https://lore.kernel.org/all/20260430010332.114100-1-sj@xxxxxxxxxx/
> > ---
> > 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
[...]