Add man page for vhost-device-scmi
#697
Comments
epilys
added a commit
to epilys/vhost-device
that referenced
this issue
Dec 7, 2024
Add vhost-device-scmi support for the mangen task in xtask binary.
This generates a manpage in target/dist/man/vhost-device-scmi.1
The rendered ROFF output looks like:
vhost-device-scmi(1) General Commands Manual vhost-device-scmi(1)
NAME
vhost-device-scmi - vhost-user SCMI backend device
SYNOPSIS
vhost-device-scmi <-s|--socket-path> [-d|--device] [--help-devices] [-h|--help] [-V|--version]
DESCRIPTION
vhost-user SCMI backend device
OPTIONS
-s, --socket-path=SOCKET_PATH
vhost-user socket to use
-d, --device=DEVICE
Devices to expose
--help-devices
Print help on available devices
-h, --help
Print help
-V, --version
Print version
VERSION
v0.3.0
REPORTING BUGS
Report bugs to the project's issue tracker: https://github.com/rust-vmm/vhost-device
vhost-device-scmi 0.3.0 vhost-device-scmi(1)
Fixes rust-vmm#697 ("Add man page for vhost-device-scmi")
Resolves: rust-vmm#697
Signed-off-by: Manos Pitsidianakis <[email protected]>
epilys
added a commit
to epilys/vhost-device
that referenced
this issue
Dec 7, 2024
Add vhost-device-scmi support for the mangen task in xtask binary.
This generates a manpage in target/dist/man/vhost-device-scmi.1
The rendered ROFF output looks like:
vhost-device-scmi(1) General Commands Manual vhost-device-scmi(1)
NAME
vhost-device-scmi - vhost-user SCMI backend device
SYNOPSIS
vhost-device-scmi <-s|--socket-path> [-d|--device] [--help-devices] [-h|--help] [-V|--version]
DESCRIPTION
vhost-user SCMI backend device
OPTIONS
-s, --socket-path=SOCKET_PATH
vhost-user socket to use
-d, --device=DEVICE
Devices to expose
--help-devices
Print help on available devices
-h, --help
Print help
-V, --version
Print version
VERSION
v0.3.0
REPORTING BUGS
Report bugs to the project's issue tracker: https://github.com/rust-vmm/vhost-device
vhost-device-scmi 0.3.0 vhost-device-scmi(1)
Fixes rust-vmm#697 ("Add man page for vhost-device-scmi")
Resolves: rust-vmm#697
Signed-off-by: Manos Pitsidianakis <[email protected]>
epilys
added a commit
to epilys/vhost-device
that referenced
this issue
Dec 10, 2024
Add vhost-device-scmi support for the mangen task in xtask binary.
This generates a manpage in target/dist/man/vhost-device-scmi.1
The rendered ROFF output looks like:
vhost-device-scmi(1) General Commands Manual vhost-device-scmi(1)
NAME
vhost-device-scmi - vhost-user SCMI backend device
SYNOPSIS
vhost-device-scmi <-s|--socket-path> [-d|--device] [--help-devices] [-h|--help] [-V|--version]
DESCRIPTION
vhost-user SCMI backend device
OPTIONS
-s, --socket-path=SOCKET_PATH
vhost-user socket to use
-d, --device=DEVICE
Devices to expose
--help-devices
Print help on available devices
-h, --help
Print help
-V, --version
Print version
VERSION
v0.3.0
REPORTING BUGS
Report bugs to the project's issue tracker: https://github.com/rust-vmm/vhost-device
vhost-device-scmi 0.3.0 vhost-device-scmi(1)
Fixes rust-vmm#697 ("Add man page for vhost-device-scmi")
Resolves: rust-vmm#697
Signed-off-by: Manos Pitsidianakis <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
A man page for
vhost-device-scmihas been prepared for Fedora packaging.It would be nice to get it included in the upstream project.
The patch adding the man page is here: https://src.fedoraproject.org/rpms/rust-vhost-device-scmi/blob/rawhide/f/rust-vhost-device-scmi-man-page.patch
See also #687
The text was updated successfully, but these errors were encountered: