Re: Links to sources in docs

[Jani Nikula <jani.nikula@linux.intel.com>]

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.


HTH,
Jani.


[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks


>
> which leads to link to the source [1]. But if i try to use the same pattern in
> Documentation/trace/fprobe.rst:
>
> -See Filter Commands in `Documentation/trace/ftrace.rst`.
> +See Filter Commands in Documentation/trace/ftrace.rst.
>
> it does not work:
>
> Documentation/admin-guide/bug-hunting.rst:54: ERROR: Unknown target name: "scripts/decode_stacktrace.sh". [docutils]
>
> Kind regards,
> Petr
>
> [1] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/samples/check-exec/inc.c
>

-- 
Jani Nikula, Intel