From: Valentin Obst <kernel@valentinobst.de>
To: Miguel Ojeda <ojeda@kernel.org>,
Alex Gaynor <alex.gaynor@gmail.com>,
Wedson Almeida Filho <wedsonaf@gmail.com>,
Trevor Gross <tmgross@umich.edu>
Cc: "Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <benno.lossin@proton.me>,
"Andreas Hindborg" <a.hindborg@samsung.com>,
"Alice Ryhl" <aliceryhl@google.com>,
rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
"Valentin Obst" <kernel@valentinobst.de>
Subject: Re: [PATCH 04/13] rust: kernel: add srctree-relative doclinks
Date: Thu, 18 Jan 2024 09:30:42 +0100 [thread overview]
Message-ID: <20240118083042.21307-1-kernel@valentinobst.de> (raw)
In-Reply-To: <CALNs47u037Bjk60E4x+c0+fk+2v5sc8iDzD0ztyqyJRdMDBgeg@mail.gmail.com>
> Hm, I wonder if we could figure out a way to make links point to
> specific definitions in the C headers with # anchors. I'm not sure
> what the intended platform to view these links is.
Currently the links simply open the plain .h file from your local tree in your
browser, i.e.,
```rust
/// [`struct wait_queue_head`]: srctree/include/linux/wait.h
```
becomes something like:
file:///mnt/build/rust-for-linux/rust4lx/include/linux/wait.h
and fragments won't work on that.
I agree that it would be nice to link to type definitions, variables,
functions, ect. in the file, maybe with something like:
```
#(type|var|func);<identifier>
```
However, I think this will require some parsing and embedding the C
source file into some html.
next prev parent reply other threads:[~2024-01-18 8:31 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-16 16:01 [PATCH 00/13] rust: kernel: documentation improvements Valentin Obst
2024-01-16 16:01 ` [PATCH 01/13] rust: kernel: fix multiple typos in documentation Valentin Obst
2024-01-18 1:47 ` Trevor Gross
2024-01-16 16:01 ` [PATCH 02/13] rust: error: move unsafe block into function call Valentin Obst
2024-01-18 0:31 ` Trevor Gross
2024-01-18 8:10 ` Valentin Obst
2024-01-16 16:01 ` [PATCH 03/13] rust: ioctl: end top level module docs with full stop Valentin Obst
2024-01-18 0:32 ` Trevor Gross
2024-01-18 1:08 ` Trevor Gross
2024-01-16 22:04 ` [PATCH 04/13] rust: kernel: add srctree-relative doclinks Valentin Obst
2024-01-18 0:38 ` Trevor Gross
2024-01-18 8:30 ` Valentin Obst [this message]
2024-01-16 22:05 ` [PATCH 05/13] rust: str: use `NUL` instead of 0 in doc comments Valentin Obst
2024-01-18 0:39 ` Trevor Gross
2024-01-16 22:06 ` [PATCH 06/13] rust: str: move SAFETY comment in front of unsafe block Valentin Obst
2024-01-18 0:48 ` Trevor Gross
2024-01-16 22:06 ` [PATCH 07/13] rust: kernel: unify spelling of refcount in docs Valentin Obst
2024-01-18 1:05 ` Trevor Gross
2024-01-16 23:09 ` [PATCH 08/13] rust: kernel: mark code fragments in docs with backticks Valentin Obst
2024-01-18 1:10 ` Trevor Gross
2024-01-16 23:10 ` [PATCH 09/13] rust: kernel: add blank lines in front of code blocks Valentin Obst
2024-01-18 1:11 ` Trevor Gross
2024-01-16 23:11 ` [PATCH 10/13] rust: kernel: add doclinks Valentin Obst
2024-01-18 1:42 ` Trevor Gross
2024-01-18 8:41 ` Valentin Obst
2024-01-16 23:11 ` [PATCH 11/13] rust: kernel: add doclinks with html tags Valentin Obst
2024-01-17 1:47 ` Martin Rodriguez Reboredo
2024-01-17 9:10 ` Valentin Obst
2024-01-17 21:41 ` Martin Rodriguez Reboredo
2024-01-18 2:28 ` Trevor Gross
2024-01-18 9:14 ` Valentin Obst
2024-01-17 0:15 ` [PATCH 12/13] rust: kernel: remove unneeded doclink targets Valentin Obst
2024-01-18 1:14 ` Trevor Gross
2024-01-18 1:21 ` Trevor Gross
2024-01-17 0:16 ` [PATCH 13/13] rust: locked_by: shorten doclink preview Valentin Obst
2024-01-18 1:18 ` Trevor Gross
2024-01-30 9:18 ` Alice Ryhl
2024-01-17 1:41 ` [PATCH 00/13] rust: kernel: documentation improvements Martin Rodriguez Reboredo
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=20240118083042.21307-1-kernel@valentinobst.de \
--to=kernel@valentinobst.de \
--cc=a.hindborg@samsung.com \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=benno.lossin@proton.me \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=gary@garyguo.net \
--cc=linux-kernel@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
--cc=wedsonaf@gmail.com \
/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;
as well as URLs for NNTP newsgroup(s).