Skip to content

Commit fbc1475

Browse files
committed
doc: Add Rust PCI Readme
Signed-off-by: Andreas Hindborg <[email protected]>
1 parent 974593a commit fbc1475

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
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 Restructured Text markup notation.
8+
* device
9+
* pci
10+
* irq
11+
* iomem
12+
* dma
1513

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.
14+
Please note that these patches
15+
16+
* are full of todo items
17+
* are missing safety comments
18+
* were not reviewed on list for soundness

0 commit comments

Comments
 (0)