mirrors/crosvm
1
0
Fork 0
mirror of https://chromium.googlesource.com/crosvm/crosvm synced 2025-02-10 12:09:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

crosvm: devices: document serial option properly

Browse source 
Repeat the help text present in the run command. The duplication is
unfortunate but there doesn't seem to be a better way to handle this
with argh at the moment.

BUG=b:217480043
TEST=cargo build

Change-Id: I36bc2ff030f161f4c4ea3572fb31525cc8435cfd
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3827607
Tested-by: Alexandre Courbot <acourbot@chromium.org>
Commit-Queue: Alexandre Courbot <acourbot@chromium.org>
Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org>
Reviewed-by: Junichi Uekawa <uekawa@chromium.org>
This commit is contained in:
Alexandre Courbot 2022-08-03 13:17:40 +09:00 committed by crosvm LUCI
parent 2182db8b32
commit 199e3bf435
1 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/crosvm/sys/unix/cmdline.rs
View file

@ -59,10 +59,31 @@ pub struct DevicesCommand {
#[argh(
option,
arg_name = "serial options",
arg_name = "vhost=PATH,type=TYPE,[hardware=HW,num=NUM,path=PATH,input=PATH,console,earlycon,stdin]",
from_str_fn(parse_vu_serial_options)
)]
/// start a serial device (see help from run command for options)
/// comma separated key=value pairs for setting up serial
/// devices. Can be given more than once.
/// Possible key values:
/// vhost=PATH - Path to a vhost-user endpoint to listen to.
/// type=(stdout,syslog,sink,file) - Where to route the
/// serial device
/// hardware=(serial,virtio-console) - Which type of serial
/// hardware to emulate. Defaults to 8250 UART (serial).
/// num=(1,2,3,4) - Serial Device Number. If not provided,
/// num will default to 1.
/// path=PATH - The path to the file to write to when
/// type=file
/// input=PATH - The path to the file to read from when not
/// stdin
/// console - Use this serial device as the guest console.
/// Can only be given once. Will default to first
/// serial port if not provided.
/// earlycon - Use this serial device as the early console.
/// Can only be given once.
/// stdin - Direct standard input to this serial device.
/// Can only be given once. Will default to first serial
/// port if not provided.
pub serial: Vec<VhostUserParams<SerialParameters>>,
#[argh(option, arg_name = "block options")]