mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: Carlos Bilbao <carlos.bilbao@amd.com>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	konstantin@linuxfoundation.org, ojeda@kernel.org, corbet@lwn.net,
	jani.nikula@linux.intel.com, rdunlap@infradead.org,
	Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH v4 1/2] docs: Move rustdoc output, cross-reference it
Date: Thu, 8 Dec 2022 07:57:50 +0900	[thread overview]
Message-ID: <e3d15de9-521c-5017-112a-6cc7fcd54437@gmail.com> (raw)
In-Reply-To: <20221207173053.1463800-2-carlos.bilbao@amd.com>

Hi,

On Wed, 7 Dec 2022 11:30:52 -0600, Carlos Bilbao wrote:
> Generate rustdoc documentation with the rest of subsystem's documentation
> in Documentation/output. Add a cross reference to the generated rustdoc in
> Documentation/rust/index.rst if Sphinx target rustdoc is set.

The note on rustdoc won't help much in non-html outputs.
Please apply patch below on top.

You can keep my Rb tag.

When rustdoc arrives at https://www.kernel.org/doc/, a note
for non-html outputs directing people there might be helpful,
I guess.

        Thanks, Akira

> 
> Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
> Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com>
> ---
>  Documentation/rust/index.rst |  8 ++++++++
>  rust/Makefile                | 15 +++++++++------
>  2 files changed, 17 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/rust/index.rst b/Documentation/rust/index.rst
> index 4ae8c66b94fa..4fc97c1eb1d1 100644
> --- a/Documentation/rust/index.rst
> +++ b/Documentation/rust/index.rst
> @@ -6,6 +6,14 @@ Rust
>  Documentation related to Rust within the kernel. To start using Rust
>  in the kernel, please read the quick-start.rst guide.
>  
> +.. only:: rustdoc
> +
> +	You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
> +
> +.. only:: not rustdoc
> +
> +	This documentation does not include rustdoc generated information.
> +
>  .. toctree::
>      :maxdepth: 1
>  

--- a/Documentation/rust/index.rst
+++ b/Documentation/rust/index.rst
@@ -6,11 +6,11 @@ Rust
 Documentation related to Rust within the kernel. To start using Rust
 in the kernel, please read the quick-start.rst guide.
 
-.. only:: rustdoc
+.. only:: rustdoc and html
 
 	You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
 
-.. only:: not rustdoc
+.. only:: not rustdoc and html
 
 	This documentation does not include rustdoc generated information.
 
-- 


  parent reply	other threads:[~2022-12-07 22:58 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-07 17:30 [PATCH v4 0/2] docs: Integrate rustdoc into Rust documentation Carlos Bilbao
2022-12-07 17:30 ` [PATCH v4 1/2] docs: Move rustdoc output, cross-reference it Carlos Bilbao
2022-12-07 20:46   ` Jani Nikula
2022-12-07 22:57   ` Akira Yokosawa [this message]
2022-12-28 17:43     ` Carlos Bilbao
2022-12-07 17:30 ` [PATCH v4 2/2] docs: Integrate rustdoc generation into htmldocs Carlos Bilbao
2022-12-28 17:46 ` [PATCH v5 0/2] docs: Integrate rustdoc into Rust documentation Carlos Bilbao
2022-12-28 17:46   ` [PATCH v5 1/2] docs: Move rustdoc output, cross-reference it Carlos Bilbao
2022-12-28 17:46   ` [PATCH v5 2/2] docs: Integrate rustdoc generation into htmldocs Carlos Bilbao
2023-01-02 23:53   ` [PATCH v5 0/2] docs: Integrate rustdoc into Rust documentation Jonathan Corbet
2023-01-03 14:06     ` Carlos Bilbao
2023-01-04  0:20       ` Jonathan Corbet
2023-01-03 14:19     ` Miguel Ojeda
2023-01-04  0:25       ` Jonathan Corbet
2023-01-04  1:55         ` Miguel Ojeda
2023-01-04 14:53           ` Jonathan Corbet
2023-01-04 19:54             ` Carlos Bilbao

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=e3d15de9-521c-5017-112a-6cc7fcd54437@gmail.com \
    --to=akiyks@gmail.com \
    --cc=carlos.bilbao@amd.com \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@linux.intel.com \
    --cc=konstantin@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ojeda@kernel.org \
    --cc=rdunlap@infradead.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

all inboxes | Powered by JetHome®