linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Matthew Wilcox <willy@infradead.org>
To: linux-doc@vger.kernel.org
Subject: How to cross-link to another document?
Date: Wed, 6 Jul 2022 18:15:43 +0100	[thread overview]
Message-ID: <YsXDP3r59jlOTXGb@casper.infradead.org> (raw)


I've tried several variants of this without success.  What's the
correct incantation?

+++ b/Documentation/core-api/idr.rst
@@ -17,6 +17,8 @@ solution to the problem to avoid everybody inventing their own.  The IDR
 provides the ability to map an ID to a pointer, while the IDA provides
 only ID allocation, and as a result is much more memory-efficient.

+The IDR interface is deprecated; please use the _`XArray` instead.
+
 IDR usage
 =========

+++ b/Documentation/core-api/xarray.rst
@@ -1,4 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0+
+.. XArray_

 ======
 XArray

I first tried "named reference, reStructuredText_;"
and then "_`inline internal target`" and I've tried both prefixing and
suffixing both destination and target with an underscore.  Nothing seems
to work and sometimes I get error messages telling me it won't work,
and sometimes I just get non-hyperlinks.

Do I have to do something like

	:ref:`Documentation/core-api/xarray.rst <XArray>`
?  That would seem unnecessarily verbose.

             reply	other threads:[~2022-07-06 17:15 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-06 17:15 Matthew Wilcox [this message]
2022-07-07  8:10 ` How to cross-link to another document? Akira Yokosawa

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=YsXDP3r59jlOTXGb@casper.infradead.org \
    --to=willy@infradead.org \
    --cc=linux-doc@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).