Skip to content

Commit

Permalink
doc: Add Rust PCI Readme
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Hindborg <a.hindborg@samsung.com>
  • Loading branch information
metaspace committed Feb 8, 2024
1 parent 974593a commit fbc1475
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
Linux kernel
============

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

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

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

There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.
* device
* pci
* irq
* iomem
* dma

Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.
Please note that these patches

* are full of todo items
* are missing safety comments
* were not reviewed on list for soundness

0 comments on commit fbc1475

Please sign in to comment.