mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Carlos Bilbao <carlos.bilbao@amd.com>,
	ojeda@kernel.org, jani.nikula@linux.intel.com,
	rdunlap@infradead.org
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	konstantin@linuxfoundation.org, bilbao@vt.edu,
	Carlos Bilbao <carlos.bilbao@amd.com>
Subject: Re: [PATCH v6 0/2] docs: Integrate rustdoc into Rust documentation
Date: Fri, 03 Feb 2023 10:55:46 -0700	[thread overview]
Message-ID: <87pmaqskf1.fsf@meer.lwn.net> (raw)
In-Reply-To: <20230127165728.119507-1-carlos.bilbao@amd.com>

Carlos Bilbao <carlos.bilbao@amd.com> writes:

> Include HTML output generated with rustdoc into the Linux kernel
> documentation on Rust.
>
> Carlos Bilbao:
>  docs: Move rustdoc output, cross-reference it
>  docs: Integrate rustdoc generation into htmldocs
>
So I spent a fair while messing with this, really hoping to get it
merged for 6.3, but I think it's still just too fragile.

- With a too-new version of bindgen it kills the htmldocs build
  entirely.  If we can't build the Rust docs successfully with the
  toolchain that the user has installed then so be it, but it shouldn't
  wreck the docs build entirely.

- It still throws the user into the "make oldconfig" process, which is
  unexpected for a docs build.  This happens even on a system with no
  Rust installed at all.

- I dumped my Fedora toolchain and did the curl|bash ritual to set up
  the proper versions with rustup.  It would be nice to have some better
  documentation on how to do that ... *how* to install bindgen may not
  be obvious to all users.  It also failed until I installed lld
  separately.

On a system with the right tool versions, and with a kernel already
configured to build the Rust support, it worked nicely, though.

I'd really like to see a solution that (1) doesn't kill the docs build
process if the tool versions are wrong, and (2) doesn't force the
creation of a kernel configuration.  What are our chances of getting
there?

Thanks,

jon

  parent reply	other threads:[~2023-02-03 17:56 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-27 16:57 Carlos Bilbao
2023-01-27 16:57 ` [PATCH v6 1/2] docs: Move rustdoc output, cross-reference it Carlos Bilbao
2023-01-27 16:57 ` [PATCH v6 2/2] docs: Integrate rustdoc generation into htmldocs Carlos Bilbao
2023-02-03 17:55 ` Jonathan Corbet [this message]
2023-02-04  0:05   ` [PATCH v6 0/2] docs: Integrate rustdoc into Rust documentation 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=87pmaqskf1.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=bilbao@vt.edu \
    --cc=carlos.bilbao@amd.com \
    --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®