linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@linux.intel.com>
To: Bjorn Helgaas <helgaas@kernel.org>, linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
	Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Subject: Re: stable docs.kernel.org links?
Date: Mon, 18 Mar 2024 19:35:55 +0200	[thread overview]
Message-ID: <87zfuvo32c.fsf@intel.com> (raw)
In-Reply-To: <20240318170309.GA1187959@bhelgaas>

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

  reply	other threads:[~2024-03-18 17:36 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-18 17:03 stable docs.kernel.org links? Bjorn Helgaas
2024-03-18 17:35 ` Jani Nikula [this message]
2024-03-18 17:59   ` Konstantin Ryabitsev

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=87zfuvo32c.fsf@intel.com \
    --to=jani.nikula@linux.intel.com \
    --cc=helgaas@kernel.org \
    --cc=konstantin@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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;
as well as URLs for NNTP newsgroup(s).