pxcloud/vhost-device
5
0
Fork 0
mirror of https://github.com/rust-vmm/vhost-device.git synced 2025-12-26 22:48:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

vhost-device-scmi: reformat synopsis and options

Browse Source 
The option:: doesn't render properly, follow the example of the other
devices.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
This commit is contained in:
Alex Bennée 2025-09-10 11:55:16 +01:00 committed by Manos Pitsidianakis
parent 1318b9ef16
commit f7aa60fd80
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
vhost-device-scmi/README.md
View File

@ -10,21 +10,24 @@ the Examples section below.
## Synopsis
**vhost-device-scmi** [*OPTIONS*]
```console
vhost-device-scmi [OPTIONS] --socket-path <SOCKET_PATH>
```
## Options
.. program:: vhost-device-scmi
```text
vhost-device-scmi
.. option:: -h, --help
-h, --help
Print help.
.. option:: -s, --socket-path=PATH
-s, --socket-path=PATH
Location of the vhost-user Unix domain sockets.
.. option:: -d, --device=SPEC
-d, --device=SPEC
SCMI device specification in the format `ID,PROPERTY=VALUE,...`.
For example: `-d iio,path=/sys/bus/iio/devices/iio:device0,channel=in_accel`.
@ -32,6 +35,7 @@ the Examples section below.
If no device is specified then no device will be provided to the
guest OS but VirtIO SCMI will be still available there.
Use `--help-devices` to list help on all the available devices.
```
You can set `RUST_LOG` environment variable to `debug` to get maximum
messages on the standard error output.