From 0db7d8c12c00ca5748cf1c5e7f44f81b5bd4f047 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20Benn=C3=A9e?= Date: Wed, 10 Sep 2025 11:39:31 +0100 Subject: [PATCH] vhost-device-can: 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-can/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/vhost-device-can/README.md b/vhost-device-can/README.md index ade7912..a60a849 100644 --- a/vhost-device-can/README.md +++ b/vhost-device-can/README.md @@ -12,28 +12,27 @@ This program is tested with QEMU's `vhost-user-device-pci` device. Examples' section below. ## Synopsis + +``` +vhost-device-can [OPTIONS] --socket-path --can-devices ``` -**vhost-device-can** [*OPTIONS*] -```` ## Options - -.. program:: vhost-device-can - -.. option:: -h, --help +```text + -h, --help Print help. -.. option:: -s, --socket-path=PATH + -s, --socket-path=PATH Location of vhost-user Unix domain sockets, this path will be suffixed with 0,1,2..socket_count-1. -.. option:: -c, --socket-count=INT + -c, --socket-count=INT Number of guests (sockets) to attach to, default set to 1. -.. option:: -d, --can-devices='CAN/FD interfaces' + -d, --can-devices='CAN/FD interfaces' CAN/FD device list at the host OS in the format: [] ... [] @@ -42,6 +41,7 @@ Examples' section below. provided via *socket_count* parameter. Example: --can-devices "can0 can1 can2" +``` ## Features This device is still work-in-progress (WIP) and on [virtio-spec v1.4](https://github.com/oasis-tcs/virtio-spec/blob/virtio-1.4/device-types/can/) is based