From: Wu XiangCheng <bobwxc@email.cn> To: Miguel Ojeda <ojeda@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net>, rust-for-linux@vger.kernel.org Subject: [Rust-next PATCH] rust: doc: Replace a ref tag in doc-guide/kernel-doc.rst Date: Wed, 14 Apr 2021 11:35:53 +0800 [thread overview] Message-ID: <20210414033551.GA28117@bobwxc.top> (raw) replace a ref tag to normal path tag in doc-guide/kernel-doc.rst Link: https://lore.kernel.org/linux-doc/87lf9lrgp3.fsf@meer.lwn.net/ Signed-off-by: Wu XiangCheng <bobwxc@email.cn> --- FYI: Also, there is no need for a :ref: here; just say "Documentation/rust/docs.rst" and the automarkup code will do the right thing. Yes, that should be changed in the original as well. Thanks Documentation/doc-guide/kernel-doc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index c655fdb9c042..724e2ffddff1 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -12,7 +12,7 @@ when it is embedded in source files. comments. Please stick to the style described here. .. note:: kernel-doc does not cover Rust code: please see - :ref:`Documentation/rust/docs.rst <rust_docs>` instead. + Documentation/rust/docs.rst instead. The kernel-doc structure is extracted from the comments, and proper `Sphinx C Domain`_ function and type descriptions with anchors are -- 2.20.1
next reply other threads:[~2021-04-14 3:36 UTC|newest] Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-04-14 3:35 Wu XiangCheng [this message] 2021-04-21 16:33 ` Miguel Ojeda
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=20210414033551.GA28117@bobwxc.top \ --to=bobwxc@email.cn \ --cc=corbet@lwn.net \ --cc=ojeda@kernel.org \ --cc=rust-for-linux@vger.kernel.org \ --subject='Re: [Rust-next PATCH] rust: doc: Replace a ref tag in doc-guide/kernel-doc.rst' \ /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
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).