From: Carlos Bilbao <carlos.bilbao@amd.com>
To: <ojeda@kernel.org>, <corbet@lwn.net>, <akiyks@gmail.com>,
<jani.nikula@linux.intel.com>, <rdunlap@infradead.org>
Cc: <linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<konstantin@linuxfoundation.org>,
Carlos Bilbao <carlos.bilbao@amd.com>
Subject: [PATCH v5 0/2] docs: Integrate rustdoc into Rust documentation
Date: Wed, 28 Dec 2022 11:46:21 -0600 [thread overview]
Message-ID: <20221228174623.144199-1-carlos.bilbao@amd.com> (raw)
In-Reply-To: <20221207173053.1463800-1-carlos.bilbao@amd.com>
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
---
Changes since V4:
- Limit rustdoc note only to html outputs.
Changes since V3:
- Added Reviewed-Bys from Akira Yokosawa.
- PATCH 1/2: Avoid error 404 adding tag `rustdoc` for Sphinx.
- PATCH 1/2: Don't use "here" as link text, describe destination instead.
- PATCH 2/2: Check CONFIG_RUST in a way that allows us to skip generation.
- PATCH 2/2: Reoder Sphinx runs so they complete even if rustdoc fails.
Changes since V2:
- Split v2 into two-patch series.
- Add "only:: html" directive in Documentation/rust/index.rst reference
Changes since V1:
- Work on top of v6.1-rc1.
- Don't use rustdoc.rst, instead add link to Documentation/rust/index.rst.
- In Documentation/Makefile, replace @make rustdoc for $(Q)$(MAKE) rustdoc.
- Don't do LLVM=1 for all rustdoc generation within `make htmldocs`.
- Add spaces on definition of RUSTDOC_OUTPUT, for consistency.
---
Documentation/Makefile | 8 ++++++++
Documentation/rust/index.rst | 8 ++++++++
rust/Makefile | 15 +++++++++------
3 files changed, 25 insertions(+), 6 deletions(-)
next prev parent reply other threads:[~2022-12-28 17:46 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-07 17:30 [PATCH v4 " 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
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 ` Carlos Bilbao [this message]
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=20221228174623.144199-1-carlos.bilbao@amd.com \
--to=carlos.bilbao@amd.com \
--cc=akiyks@gmail.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®