From: Jonathan Corbet <corbet@lwn.net>
To: Vegard Nossum <vegard.nossum@oracle.com>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Vegard Nossum <vegard.nossum@oracle.com>
Subject: Re: [PATCH RFC] docs: automarkup: linkify git revs
Date: Fri, 17 Nov 2023 13:37:53 -0700 [thread overview]
Message-ID: <87h6lk86am.fsf@meer.lwn.net> (raw)
In-Reply-To: <20231027115420.205279-1-vegard.nossum@oracle.com>
Vegard Nossum <vegard.nossum@oracle.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@oracle.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
prev parent reply other threads:[~2023-11-17 20:38 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-27 11:54 Vegard Nossum
2023-11-17 20:37 ` Jonathan Corbet [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=87h6lk86am.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=vegard.nossum@oracle.com \
/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®