Skip to content

Commit 4a74889

Browse files
committed
doc: Add Rust PCI Readme
Signed-off-by: Andreas Hindborg <a.hindborg@samsung.com>
1 parent a50ed67 commit 4a74889

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
1-
Linux kernel
2-
============
31

4-
There are several guides for kernel developers and users. These guides can
5-
be rendered in a number of formats, like HTML and PDF. Please read
6-
Documentation/admin-guide/README.rst first.
2+
# Rust PCI bindings for Linux
73

8-
In order to build the documentation, use ``make htmldocs`` or
9-
``make pdfdocs``. The formatted documentation can also be read online at:
4+
⚠️ The patches are work in progress ⚠️
105

11-
https://www.kernel.org/doc/html/latest/
6+
This tree hosts Rust bindings needed to interact with PCI devices, partially covering the following kernel infrastructure:
127

13-
There are various text files in the Documentation/ subdirectory,
14-
several of them using the reStructuredText markup notation.
8+
* device
9+
* pci
10+
* irq
11+
* iomem
1512

16-
Please read the Documentation/process/changes.rst file, as it contains the
17-
requirements for building and running the kernel, and information about
18-
the problems which may result by upgrading your kernel.
13+
This branch is based on
14+
15+
git https://gitlab.freedesktop.org/dakr/nova.git rust/rust-device
16+
17+
Please note that these patches
18+
19+
* are full of todo items
20+
* are missing safety comments
21+
* were not reviewed on list for soundness

0 commit comments

Comments
 (0)