Skip to content

Commit

Permalink
bhyve: Update usage and synopsis for the -k flag
Browse files Browse the repository at this point in the history
Let's make it clear to users that -k is for configuration files.
Also, point to bhyve_config(5) in the paragraph describing the flag.

Reviewed by:	jhb
MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D32467

(cherry picked from commit f656df5)
  • Loading branch information
0mp committed Oct 20, 2021
1 parent 0059520 commit dbdc8e3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 6 additions & 3 deletions usr.sbin/bhyve/bhyve.8
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd April 18, 2021
.Dd October 13, 2021
.Dt BHYVE 8
.Os
.Sh NAME
Expand All @@ -46,7 +46,7 @@
.Oc
.Sm on
.Op Fl G Ar port
.Op Fl k Ar file
.Op Fl k Ar config_file
.Oo Fl l
.Sm off
.Ar lpcdev Op Cm \&, Ar conf
Expand Down Expand Up @@ -155,7 +155,7 @@ Yield the virtual CPU thread when a HLT instruction is detected.
If this option is not specified, virtual CPUs will use 100% of a host CPU.
.It Fl h
Print help message and exit.
.It Fl k Ar file
.It Fl k Ar config_file
Set configuration variables from a simple, key-value config file.
Each line of the config file is expected to consist of a config variable
name, an equals sign
Expand All @@ -166,6 +166,9 @@ value.
Blank lines and lines starting with
.Sq #
are ignored.
See
.Xr bhyve_config 5
for more details.
.It Fl l Cm help
Print a list of supported LPC devices.
.It Fl l Ar lpcdev Ns Op Cm \&, Ns Ar conf
Expand Down
2 changes: 1 addition & 1 deletion usr.sbin/bhyve/bhyverun.c
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ usage(int code)
fprintf(stderr,
"Usage: %s [-AaCDeHhPSuWwxY]\n"
" %*s [-c [[cpus=]numcpus][,sockets=n][,cores=n][,threads=n]]\n"
" %*s [-G port] [-k file] [-l lpc] [-m mem] [-o var=value]\n"
" %*s [-G port] [-k config_file] [-l lpc] [-m mem] [-o var=value]\n"
" %*s [-p vcpu:hostcpu] [-r file] [-s pci] [-U uuid] vmname\n"
" -A: create ACPI tables\n"
" -a: local apic is in xAPIC mode (deprecated)\n"
Expand Down

0 comments on commit dbdc8e3

Please sign in to comment.