linux-kernel - Re: [PATCH v2] docs: automarkup: Move common logic to add and resolve xref to helper

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: <87a58ibuai.fsf@trenco.lwn.net>
Date: Mon, 14 Apr 2025 10:08:05 -0600
From: Jonathan Corbet <corbet@....net>
To: Nícolas F. R. A. Prado <nfraprado@...labora.com>
Cc: kernel@...labora.com, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, Nícolas F. R. A. Prado
 <nfraprado@...labora.com>
Subject: Re: [PATCH v2] docs: automarkup: Move common logic to add and
 resolve xref to helper

Nícolas F. R. A. Prado <nfraprado@...labora.com> writes:

> Several of the markup functions contain the same code, calling into
> sphinx's pending_xref and resolve_xref functions to add and resolve a
> cross-reference, with only a few of the parameters changed (domain,
> reference type, markup content). Move this logic to its own function and
> reuse it in the markup functions.
>
> No functional change.
>
> Signed-off-by: Nícolas F. R. A. Prado <nfraprado@...labora.com>
> ---
> Changes in v2:
> - Moved repeated "Go through the dance..." comment to the helper
> - Dropped "Return the xref if we got it..." comment as the helper
>   returns None in case of failure
> - Link to v1: https://lore.kernel.org/r/20250407-automarkup-resolve-xref-helper-v1-1-9cac06ad580f@collabora.com
> ---
>  Documentation/sphinx/automarkup.py | 97 ++++++++++----------------------------
>  1 file changed, 24 insertions(+), 73 deletions(-)

Applied, thanks.

jon