Miguel Ojeda 1dbaf8b1ba rust: pci: fix docs related to missing Markdown code spans ...

In particular:

  - Add missing Markdown code spans.

  - Improve title for `DeviceId`, adding a link to the struct in the
    C side, rather than referring to `bindings::`.

  - Convert `TODO` from documentation to a normal comment, and put code
    in block.

This was found using the Clippy `doc_markdown` lint, which we may want
to enable.

Fixes: 1bd8b6b2c5 ("rust: pci: add basic PCI device / driver abstractions")
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Acked-by: Danilo Krummrich <dakr@kernel.org>
Link: https://lore.kernel.org/r/20250324210359.1199574-8-ojeda@kernel.org
[ Prefixed link text with `struct`. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

2025-05-25 22:58:35 +02:00

..

alloc

rust: alloc: add missing Markdown code span

2025-05-25 22:58:35 +02:00

block

rust: convert raw URLs to Markdown autolinks in comments

2025-05-12 00:20:25 +02:00

fs

Merge tag 'rust-6.15' of git://git.kernel.org/pub/scm/linux/kernel/git/ojeda/linux

2025-03-30 17:03:26 -07:00

list

rust: use derive(CoercePointee) on rustc >= 1.84.0

2025-01-13 23:45:30 +01:00

net

rust: module: introduce authors key

2025-03-10 15:12:17 +01:00

sync

Merge tag 'rust-xarray-for-v6.16' of https://github.com/Rust-for-Linux/linux into rust-next

2025-05-18 20:36:56 +02:00

time

rust: workaround bindgen issue with forward references to enum types

2025-05-22 15:39:16 +02:00

.gitignore

rust: jump_label: skip formatting generated file

2024-11-20 13:32:42 -05:00

alloc.rs

rust: alloc: add missing Markdown code spans

2025-05-25 22:58:35 +02:00

block.rs

rust: block: introduce kernel::block::mq module

2024-06-14 07:45:04 -06:00

build_assert.rs

rust: add build_error! to the prelude

2025-01-10 00:19:09 +01:00

cred.rs

cred,rust: mark Credential methods inline

2025-03-04 17:07:49 -05:00

device_id.rs

rust: use absolute paths in macros referencing core and kernel

2025-05-23 00:12:14 +02:00

device.rs

rust: use absolute paths in macros referencing core and kernel

2025-05-23 00:12:14 +02:00

devres.rs

rust: io: fix devres test with new io accessor functions

2025-02-25 07:29:48 +01:00

dma.rs

rust: dma: add Send implementation for CoherentAllocation

2025-03-24 20:14:10 +01:00

driver.rs

rust: make pin-init its own crate

2025-03-16 21:59:19 +01:00

error.rs

Merge tag 'rust-6.15' of git://git.kernel.org/pub/scm/linux/kernel/git/ojeda/linux

2025-03-30 17:03:26 -07:00

faux.rs

rust/kernel/faux: mark Registration methods inline

2025-03-11 10:42:23 +01:00

firmware.rs

rust: firmware: Use ffi::c_char type in FwFunc

2025-04-14 14:13:23 +02:00

fs.rs

rust: file: add Rust abstraction for struct file

2024-09-30 13:02:28 +02:00

generated_arch_static_branch_asm.rs.S

rust: jump_label: skip formatting generated file

2024-11-20 13:32:42 -05:00

init.rs

Merge tag 'rust-6.15' of git://git.kernel.org/pub/scm/linux/kernel/git/ojeda/linux

2025-03-30 17:03:26 -07:00

io.rs

rust: io: rename io::Io accessors

2025-02-22 15:44:19 +01:00

ioctl.rs

rust: start using the #[expect(...)] attribute

2024-10-07 21:39:57 +02:00

jump_label.rs

rust: jump_label: skip formatting generated file

2024-11-20 13:32:42 -05:00

kunit.rs

rust: use absolute paths in macros referencing core and kernel

2025-05-23 00:12:14 +02:00

lib.rs

Merge tag 'rust-xarray-for-v6.16' of https://github.com/Rust-for-Linux/linux into rust-next

2025-05-18 20:36:56 +02:00

list.rs

rust: list: Add examples for linked list

2025-05-22 12:00:52 +02:00

miscdevice.rs

rust: types: add ForeignOwnable::PointedTo

2025-05-01 11:35:49 +02:00

net.rs

rust: core abstractions for network PHY drivers

2023-12-15 09:35:50 +00:00

of.rs

rust: of: add of::DeviceId abstraction

2024-12-20 17:21:04 +01:00

page.rs

rust: page: optimize rust symbol generation for Page

2025-05-12 00:20:25 +02:00

pci.rs

rust: pci: fix docs related to missing Markdown code spans

2025-05-25 22:58:35 +02:00

pid_namespace.rs

rust: add PidNamespace

2024-10-08 15:44:36 +02:00

platform.rs

rust: platform: fix docs related to missing Markdown code spans

2025-05-25 22:58:35 +02:00

prelude.rs

rust: add C FFI types to the prelude

2025-05-23 16:31:43 +02:00

print.rs

rust: replace rustdoc references to alloc::format

2025-05-12 00:20:25 +02:00

rbtree.rs

rust: rbtree: fix comments referring to Box instead of KBox

2025-03-23 19:43:02 +01:00

revocable.rs

rust: add Revocable type

2024-12-20 17:19:26 +01:00

security.rs

lsm,rust: reword "destroy" -> "release" in SecurityCtx

2025-03-04 15:44:46 -05:00

seq_file.rs

Merge tag 'rust-6.15' of git://git.kernel.org/pub/scm/linux/kernel/git/ojeda/linux

2025-03-30 17:03:26 -07:00

sizes.rs

rust: sizes: add commonly used constants

2024-08-30 10:27:34 +01:00

static_assert.rs

rust: use absolute paths in macros referencing core and kernel

2025-05-23 00:12:14 +02:00

std_vendor.rs

rust: convert raw URLs to Markdown autolinks in comments

2025-05-12 00:20:25 +02:00

str.rs

rust: use absolute paths in macros referencing core and kernel

2025-05-23 00:12:14 +02:00

sync.rs

Merge tag 'rust-6.15' of git://git.kernel.org/pub/scm/linux/kernel/git/ojeda/linux

2025-03-30 17:03:26 -07:00

task.rs

Merge tag 'rust-6.15' of git://git.kernel.org/pub/scm/linux/kernel/git/ojeda/linux

2025-03-30 17:03:26 -07:00

time.rs

rust: time: Introduce Instant type

2025-04-29 15:31:07 +02:00

tracepoint.rs

rust: add tracepoint support

2024-11-04 16:21:44 -05:00

transmute.rs

rust: kernel: move FromBytes and AsBytes traits to a new transmute module

2024-10-10 00:33:42 +02:00

types.rs

rust: types: add ForeignOwnable::PointedTo

2025-05-01 11:35:49 +02:00

uaccess.rs

Merge tag 'alloc-next-v6.16-2025-05-13' of https://github.com/Rust-for-Linux/linux into rust-next

2025-05-18 20:56:03 +02:00

workqueue.rs

Merge tag 'locking-core-2025-03-22' of git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip

2025-03-24 20:55:03 -07:00

xarray.rs

rust: xarray: Add an abstraction for XArray

2025-05-01 11:37:59 +02:00