linux-kernel - Re: [PATCH] Documentation: kernel-hacking: Remove :c:func: annotations

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

Message-ID: <87wm2e19ds.fsf@trenco.lwn.net>
Date: Mon, 22 Dec 2025 14:42:23 -0700
From: Jonathan Corbet <corbet@....net>
To: Thorsten Blum <thorsten.blum@...ux.dev>
Cc: Thorsten Blum <thorsten.blum@...ux.dev>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Documentation: kernel-hacking: Remove :c:func: annotations

Thorsten Blum <thorsten.blum@...ux.dev> writes:

> Remove the useless :c:func: annotations.
>
> Suggested-by: Jonathan Corbet <corbet@....net>
> Signed-off-by: Thorsten Blum <thorsten.blum@...ux.dev>
> ---
> Only applies after applying https://lore.kernel.org/lkml/20251219171827.44015-2-thorsten.blum@linux.dev/
> ---
>  Documentation/kernel-hacking/hacking.rst | 169 +++++++++++------------
>  1 file changed, 84 insertions(+), 85 deletions(-)
>
> diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
> index 06fcb7c662d3..8593ef3b8e6c 100644
> --- a/Documentation/kernel-hacking/hacking.rst
> +++ b/Documentation/kernel-hacking/hacking.rst
> @@ -49,7 +49,7 @@ User Context
>  
>  User context is when you are coming in from a system call or other trap:
>  like userspace, you can be preempted by more important tasks and by
> -interrupts. You can sleep by calling :c:func:`schedule()`.
> +interrupts. You can sleep by calling `schedule()`.

Almost ... the `backticks` are part of the :c:func: markup and need to
go as well.

Thanks,

jon