summaryrefslogtreecommitdiff
path: root/usr.sbin/bhyveload
diff options
context:
space:
mode:
authorRoman Bogorodskiy <novel@FreeBSD.org>2016-06-26 14:44:01 +0000
committerRoman Bogorodskiy <novel@FreeBSD.org>2016-06-26 14:44:01 +0000
commit6ee52c658c5a55e1bc6ca82635a0e87057510b7d (patch)
tree47ecd1fa7f04450474461ab18533a5662959d852 /usr.sbin/bhyveload
parent20de93c6c06de1a133c4660ac760e24a86fe1958 (diff)
downloadsrc-test2-6ee52c658c5a55e1bc6ca82635a0e87057510b7d.tar.gz
src-test2-6ee52c658c5a55e1bc6ca82635a0e87057510b7d.zip
bhyve: improve memory size documentation
A couple of minor memory size option related nits: - use common name 'memsize' (instead of 'max-size' or just 'size') - bhyve: update usage with memsize unit suffix, drop legacy "MB" unit - bhyveload: update usage with memsize unit suffix - bhyve(8): document default size - bhyveload(8): use memsize formatting like it's done in bhyve(8) Reviewed by: wblock, grehan Approved by: re (kib), wblock, grehan Differential Revision: https://reviews.freebsd.org/D6952
Notes
Notes: svn path=/head/; revision=302211
Diffstat (limited to 'usr.sbin/bhyveload')
-rw-r--r--usr.sbin/bhyveload/bhyveload.819
-rw-r--r--usr.sbin/bhyveload/bhyveload.c2
2 files changed, 8 insertions, 13 deletions
diff --git a/usr.sbin/bhyveload/bhyveload.8 b/usr.sbin/bhyveload/bhyveload.8
index b5663435277c..519c16b3cca6 100644
--- a/usr.sbin/bhyveload/bhyveload.8
+++ b/usr.sbin/bhyveload/bhyveload.8
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd February 26, 2016
+.Dd June 24, 2016
.Dt BHYVELOAD 8
.Os
.Sh NAME
@@ -42,7 +42,7 @@ guest inside a bhyve virtual machine
.Op Fl e Ar name=value
.Op Fl h Ar host-path
.Op Fl l Ar os-loader
-.Op Fl m Ar mem-size
+.Op Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
.Ar vmname
.Sh DESCRIPTION
.Nm
@@ -103,16 +103,12 @@ will use
which presents a standard
.Fx
loader.
-.It Fl m Ar mem-size Xo
-.Sm off
-.Op Cm K | k | M | m | G | g | T | t
-.Xc
-.Sm on
-.Ar mem-size
+.It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
+.Ar memsize
is the amount of memory allocated to the guest.
.Pp
The
-.Ar mem-size
+.Ar memsize
argument may be suffixed with one of
.Cm K ,
.Cm M ,
@@ -123,9 +119,8 @@ or
Kilobytes, Megabytes, Gigabytes or Terabytes
respectively.
.Pp
-The default value of
-.Ar mem-size
-is 256M.
+.Ar memsize
+defaults to 256M.
.It Fl C
Include guest memory in the core file when
.Nm
diff --git a/usr.sbin/bhyveload/bhyveload.c b/usr.sbin/bhyveload/bhyveload.c
index 9df680f57121..c67a2f698936 100644
--- a/usr.sbin/bhyveload/bhyveload.c
+++ b/usr.sbin/bhyveload/bhyveload.c
@@ -648,7 +648,7 @@ usage(void)
fprintf(stderr,
"usage: %s [-S][-c <console-device>] [-d <disk-path>] [-e <name=value>]\n"
- " %*s [-h <host-path>] [-m mem-size] <vmname>\n",
+ " %*s [-h <host-path>] [-m memsize[K|k|M|m|G|g|T|t]] <vmname>\n",
progname,
(int)strlen(progname), "");
exit(1);