On Mon, 26 Sep 2022 08:46:18 +0700, Bagas Sanjaya wrote:

On 9/26/22 08:09, Akira Yokosawa wrote:

quoted

Wait!
Bagas, your suggestion is _against_ the preference of kernel documentation.
See https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html#cross-referencing

Or do you have some good reason to add labels at the beginning of
rst docs?

Ah, I don't see that :doc: directive is possible in that case, thanks.

BTW, I prefer the link text be not full path to document (like
Documentation/path/to/foo.rst), but rather either the linked doc's title
or custom text.

Again, your preference is _against_ the preference mentioned in the
cross-referencing section, quoted below:

    For most use cases, the former is preferred, as it is cleaner and more suited
    for people reading the source files. If you come across a :doc: usage that
    isn't adding any value, please feel free to convert it to just the document path.

        Thanks, Akira