From bbc93151c4f6457f225a767ad5a08f1112e814da Mon Sep 17 00:00:00 2001 From: Phil Estes Date: Fri, 7 Jul 2017 15:51:28 -0400 Subject: [PATCH] Fix markdown format mistake and text re: disk path Formatting was incorrect due to mismatched mark; also, it appears that qemu also uses the state directory now for the created disk image. Also used the same italicized style for param reference in text instead of some bracketed and some italicized. Signed-off-by: Phil Estes --- docs/external-disk.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/external-disk.md b/docs/external-disk.md index 2fbb4969f..5f792603f 100644 --- a/docs/external-disk.md +++ b/docs/external-disk.md @@ -11,9 +11,9 @@ All local `linuxkit run` methods (currently `hyperkit`, `qemu`, and `vmware`) ta * `-disk path,size=100M,format=qcow2`. For size the default is in GB but an `M` can be appended to specify sizes in MB. The format can be omitted for the platform default, and is only useful on `qemu` at present. -If the _path` is specified it will use the disk at location _path_, if you do not provide `-disk `_path_, `linuxkit` assumes a default, which is _prefix_`-state/disk.img` for `hyperkit` and `vmware` and _prefix_`-disk.img` for `qemu`. +If a _path_ is specified `linuxkit` will use the disk at location _path_. If you do not provide `-disk ` _path_, `linuxkit` assumes a default path, which is _prefix_`-state/disk.img`. -If the disk at the specified or default `` does not exist, `linuxkit` will create one of size ``. +If the disk at the specified or default _path_ does not exist, `linuxkit` will create one of size _size_. The `-disk` specification may be repeated for multiple disks, although a limited number may be supported, and some platforms currently only support a single disk.