Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
MIME-Version: 1.0
References: <20221128201932.168313-1-carlos.bilbao@amd.com>
In-Reply-To: <20221128201932.168313-1-carlos.bilbao@amd.com>
From:   Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Date:   Mon, 28 Nov 2022 22:06:32 +0100
Message-ID: <CANiq72md-b75NQ2o7mDuGwK4JaPunrN36GZ2vUDm_yK+yocFtQ@mail.gmail.com>
Subject: Re: [PATCH] docs: Integrate rustdoc-generated output to Rust docs
To:     Carlos Bilbao <carlos.bilbao@amd.com>
Cc:     corbet@lwn.net, ojeda@kernel.org, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org, bilbao@vt.edu,
        Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Mon, Nov 28, 2022 at 9:19 PM Carlos Bilbao <carlos.bilbao@amd.com> wrote:
>
> Include HTML output generated from rustdoc into the Linux kernel
> documentation on Rust. Add Makefile target `make htmlrust` to combine
> make htmldocs and the generation of Rust documentation.

I think Konstantin (Cc'ing him) wanted us to integrate this into
`htmldocs`, rather than having a new target. That is, if `CONFIG_RUST`
is enabled, call the `rustdoc` target there.

In any case, I will also comment on this approach below. Thanks for this!

> +ifdef CONFIG_RUST
> +htmlrust:
> +       @make rustavailable

Why was this needed?

> +       @make LLVM=1 rustdoc
> +       @cp -r rust/doc/* Documentation/output/

We should change `rustdoc` to generate the docs directly in the right
place now that we have one.

Cheers,
Miguel