stable docs.kernel.org links?

stable docs.kernel.org links?

[Bjorn Helgaas]

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.

Bjorn

Re: stable docs.kernel.org links?

[Jani Nikula]

On Mon, 18 Mar 2024, Bjorn Helgaas <helgaas@kernel.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

Re: stable docs.kernel.org links?

[Konstantin Ryabitsev]

On Mon, Mar 18, 2024 at 07:35:55PM +0200, Jani Nikula wrote:
> 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

Also works as https://docs.kernel.org/6.8/core-api/genalloc.html

No guarantees beyond the usual "we did this on purpose and don't intend to break this." :)

-K