linux-kernel - Re: [PATCH RFC] docs: automarkup: linkify git revs

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87h6lk86am.fsf@meer.lwn.net>
Date:   Fri, 17 Nov 2023 13:37:53 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Vegard Nossum <vegard.nossum@...cle.com>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Vegard Nossum <vegard.nossum@...cle.com>
Subject: Re: [PATCH RFC] docs: automarkup: linkify git revs

Vegard Nossum <vegard.nossum@...cle.com> writes:

> There aren't a ton of references to commits in the documentation, but
> they do exist, and we can use automarkup to linkify them to make them
> easier to follow.
>
> Use something like this to find references to commits:
>
>   git grep -P 'commit.*[0-9a-f]{8,}' Documentation/
>
> Also fix a few of these to standardize on the exact format that is
> already used in changelogs.
>
> Signed-off-by: Vegard Nossum <vegard.nossum@...cle.com>
> ---
>  Documentation/arch/x86/boot.rst           |  2 +-
>  Documentation/bpf/btf.rst                 |  6 ++----
>  Documentation/doc-guide/sphinx.rst        |  9 +++++++++
>  Documentation/livepatch/callbacks.rst     |  4 ++--
>  Documentation/networking/snmp_counter.rst | 16 ++++++----------
>  Documentation/sphinx/automarkup.py        | 20 +++++++++++++++++++-
>  6 files changed, 39 insertions(+), 18 deletions(-)

That seems to work nicely.  Applied, thanks.

jon