From f7aa60fd806a166fad6b1457d2be5947f771c2fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20Benn=C3=A9e?= Date: Wed, 10 Sep 2025 11:55:16 +0100 Subject: [PATCH] vhost-device-scmi: reformat synopsis and options MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The option:: doesn't render properly, follow the example of the other devices. Signed-off-by: Alex Bennée --- vhost-device-scmi/README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/vhost-device-scmi/README.md b/vhost-device-scmi/README.md index 00ff431..5d21b7e 100644 --- a/vhost-device-scmi/README.md +++ b/vhost-device-scmi/README.md @@ -10,21 +10,24 @@ the Examples section below. ## Synopsis -**vhost-device-scmi** [*OPTIONS*] +```console +vhost-device-scmi [OPTIONS] --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.