public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@linux.intel.com>
To: Petr Vorel <pvorel@suse.cz>, Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: Re: Links to sources in docs
Date: Tue, 13 Jan 2026 15:26:55 +0200	[thread overview]
Message-ID: <5e697ed9df17a93570dabcf4728c6d5d2132598b@intel.com> (raw)
In-Reply-To: <20260113123203.GA320708@pevik>

On Tue, 13 Jan 2026, Petr Vorel <pvorel@suse.cz> wrote:
>> > On Fri, 09 Jan 2026, Petr Vorel <pvorel@suse.cz> wrote:
>> > > Hi Jonathan, all,
>
>> > > I wonder how links in sources work.
>
>> > > Documentation/userspace-api/check_exec.rst has:
>
>> > > `samples/check-exec/inc.c`_ example.
>
>> > There's this bit at the end of check_exec.rst that defines the link:
>
>> > .. _samples/check-exec/inc.c:
>> >    https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/samples/check-exec/inc.c
>
>> > The content within the backticks is just the link text, and has no
>> > filename semantics. See [1] for details.
>
>> Thanks for a hint, I overlooked it.
>
> And I also wonder what does clickable links (e.g. [1]) in
> Documentation/process/adding-syscalls.rst [2]
>
>     - commit 75069f2b5bfb ("vfs: renumber FMODE_NONOTIFY and add to uniqueness
>       check")
>     - commit 12ed2e36c98a ("fanotify: FMODE_NONOTIFY and __O_SYNC in sparc
>       conflict")
>     - commit bb458c644a59 ("Safer ABI for O_TMPFILE")
>
> I haven't found anything in the document itself, nor in conf.py.

It's the automarkup extension, configured in conf.py extensions, and
implemented in Documentation/sphinx/automarkup.py.

BR,
Jani.

>
> Kind regards,
> Petr
>
> [1] https://git.kernel.org/torvalds/c/75069f2b5bfb
> [2] https://docs.kernel.org/process/adding-syscalls.html#references-and-sources
> ...

-- 
Jani Nikula, Intel

      reply	other threads:[~2026-01-13 13:26 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-09 17:31 Links to sources in docs Petr Vorel
2026-01-12 11:06 ` Jani Nikula
2026-01-12 13:26   ` Petr Vorel
2026-01-13 12:32     ` Petr Vorel
2026-01-13 13:26       ` Jani Nikula [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=5e697ed9df17a93570dabcf4728c6d5d2132598b@intel.com \
    --to=jani.nikula@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=pvorel@suse.cz \
    /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