Skip to content

Commit 7432545

Browse files
committed
docs: reorder sections (Install/Completion/Usage/Related); refresh banner
README sections reordered to the canonical sibling-tool layout: Install, Shell completion, Usage, Related. Adds a Usage section showing the common `--list`, `--bind`, and `--unbind` invocations along with a sample `--list` output that includes the memlock limits block. Banner SVG regenerated from ~/git/banners so the tagline matches the current pyproject description ("Inspect and control PCI device-driver binding in Linux"). Bumps __version__ to 0.3.6. Signed-off-by: Simon A. F. Lund <os@safl.dk>
1 parent 3ce2e89 commit 7432545

3 files changed

Lines changed: 25 additions & 2 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,29 @@ devbind --print-completion bash > ~/.local/share/bash-completion/completions/dev
2929

3030
Open a new shell (or `source` the file) and tab-completion is live: `devbind --bind <TAB>` lists `nvme vfio-pci vfio-noiommu uio_pci_generic`.
3131

32+
## Usage
33+
34+
```
35+
devbind --list # list NVMe devices and their drivers
36+
sudo devbind --bind vfio-pci --device 0000:01:00.0 # bind one device to vfio-pci
37+
sudo devbind --bind nvme --device 0000:01:00.0 # rebind to the native driver
38+
sudo devbind --unbind --device 0000:01:00.0 # unbind without rebinding
39+
```
40+
41+
`devbind --list` sample output:
42+
43+
```
44+
system:
45+
drivers:
46+
- nvme: {'available': True}
47+
- uio_pci_generic: {'available': True}
48+
- vfio-noiommu: {'available': False}
49+
- vfio-pci: {'available': True}
50+
limits:
51+
memlock_soft: unlimited
52+
memlock_hard: unlimited
53+
```
54+
3255
## Related
3356

3457
- [`iommu`](https://github.com/safl/iommu): inspect and configure the IOMMU isolation level in Linux.

assets/banner.svg

Lines changed: 1 addition & 1 deletion
Loading

src/devbind/devbind.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
from pathlib import Path
4040
from dataclasses import dataclass, asdict, field
4141

42-
__version__ = "0.3.5"
42+
__version__ = "0.3.6"
4343

4444
PCIE_DEFAULT_CLASSCODE = 0x0108 # Mass Storage - NVM
4545

0 commit comments

Comments
 (0)