linux-kernel - Re: stable docs.kernel.org links?

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

Message-ID: <87zfuvo32c.fsf@intel.com>
Date: Mon, 18 Mar 2024 19:35:55 +0200
From: Jani Nikula <jani.nikula@...ux.intel.com>
To: Bjorn Helgaas <helgaas@...nel.org>, linux-doc@...r.kernel.org
Cc: linux-kernel@...r.kernel.org, Konstantin Ryabitsev
 <konstantin@...uxfoundation.org>
Subject: Re: stable docs.kernel.org links?

On Mon, 18 Mar 2024, Bjorn Helgaas <helgaas@...nel.org> wrote:
> When providing a URL to a bit of code, it's nice if the URL remains
> useful indefinitely, e.g., this should work "forever" because it
> includes a git tag:
>
>   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/drivers/pci/pci.c?id=v6.8#n1300
>
> Is there a similar "id=" mechanism for https://docs.kernel.org?  I
> could use https://docs.kernel.org/core-api/genalloc.html, but the link
> may become stale as docs get reorganized.
>
> I could link to the .rst file directly with the git tag, e.g.,
>
>   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/core-api/genalloc.rst?id=v6.8
>
> but of course that's not as nicely formatted.

This works, but I don't know if there are any guarantees that it keeps
working:

https://www.kernel.org/doc/html/v6.8/core-api/genalloc.html

Cc: Konstantin

BR,
Jani.

-- 
Jani Nikula, Intel