Received-SPF: pass (google.com: domain of linux-kernel+bounces-4094-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Date: Mon, 18 Dec 2023 16:47:42 +0000
To: Miguel Ojeda <ojeda@kernel.org>, Wedson Almeida Filho <wedsonaf@gmail.com>, Alex Gaynor <alex.gaynor@gmail.com>
From: Benno Lossin <benno.lossin@proton.me>
Cc: Boqun Feng <boqun.feng@gmail.com>, Gary Guo <gary@garyguo.net>, =?utf-8?Q?Bj=C3=B6rn_Roy_Baron?= <bjorn3_gh@protonmail.com>, Andreas Hindborg <a.hindborg@samsung.com>, Alice Ryhl <aliceryhl@google.com>, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, FUJITA Tomonori <fujita.tomonori@gmail.com>
Subject: Re: [PATCH] rust: support `srctree`-relative links
Message-ID: <1779a7c6-bacc-4c3f-a30d-0dcd6865e1e0@proton.me>
In-Reply-To: <20231215235428.243211-1-ojeda@kernel.org>
References: <20231215235428.243211-1-ojeda@kernel.org>
Feedback-ID: 71780778:user:proton
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable

On 12/16/23 00:54, Miguel Ojeda wrote:
> Some of our links use relative paths in order to point to files in the
> source tree, e.g.:
>=20
>     //! C header: [`include/linux/printk.h`](../../../../include/linux/pr=
intk.h)
>     /// [`struct mutex`]: ../../../../include/linux/mutex.h
>=20
> These are problematic because they are hard to maintain and do not suppor=
t
> `O=3D` builds.
>=20
> Instead, provide support for `srctree`-relative links, e.g.:
>=20
>     //! C header: [`include/linux/printk.h`](srctree/include/linux/printk=
.h)
>     /// [`struct mutex`]: srctree/include/linux/mutex.h
>=20
> The links are fixed after `rustdoc` generation to be based on the absolut=
e
> path to the source tree.
>=20
> Essentially, this is the automatic version of Tomonori's fix [1],
> suggested by Gary [2].
>=20
> Suggested-by: Gary Guo <gary@garyguo.net>
> Reported-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
> Closes: https://lore.kernel.org/r/20231026.204058.2167744626131849993.fuj=
ita.tomonori@gmail.com [1]
> Fixes: 48fadf440075 ("docs: Move rustdoc output, cross-reference it")
> Link: https://lore.kernel.org/rust-for-linux/20231026154525.6d14b495@euge=
o/ [2]
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

This is nice.

Reviewed-by: Benno Lossin <benno.lossin@proton.me>

--=20
Cheers,
Benno