scripts/vagrant: update help message

Just moving stuff around and updating some information.
I just felt like it's needed.

Signed-off-by: Karol Latecki <karol.latecki@intel.com>
Change-Id: Ia41f99603fb60111924cd5a3daf3c44091245c89
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/1157
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Maciej Wawryk <maciejx.wawryk@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
This commit is contained in:
Karol Latecki 2020-03-05 09:41:38 +01:00 committed by Tomasz Zawadzki
parent e16128cece
commit 53dbdf6dce

View File

@ -17,28 +17,29 @@ SPDK_DIR="$( cd "${DIR}/../../" && pwd )"
# The command line help # The command line help
display_help() { display_help() {
echo echo
echo " Usage: ${0##*/} [-b nvme-backing-file] [-n <num-cpus>] [-s <ram-size>] [-x <http-proxy>] [-hvrld] <distro>" echo " Usage: ${0##*/} [-b nvme-backing-file] [-n <num-cpus>] [-s <ram-size>] [-x <http-proxy>] [-hvrldcu] <distro>"
echo echo
echo " distro = <centos7 | centos8| ubuntu1604 | ubuntu1804 |" echo " distro = <centos7 | centos8| ubuntu1604 | ubuntu1804 |"
echo " fedora30 | fedora31 | freebsd11 | freebsd12 | arch>" echo " fedora30 | fedora31 | freebsd11 | freebsd12 | arch>"
echo echo
echo " -b <nvme-backing-file> nvme file path with name" echo " -s <ram-size> in kb Default: ${SPDK_VAGRANT_VMRAM}"
echo " type of emulated nvme disk" echo " -n <num-cpus> 1 to 4 Default: ${SPDK_VAGRANT_VMCPU}"
echo " usage: type <number_of_namespaces> types available: ocssd, nvme" echo " -x <http-proxy> Default: \"${SPDK_VAGRANT_HTTP_PROXY}\""
echo " -p <provider> \"libvirt\" or \"virtualbox\". Default: ${SPDK_VAGRANT_PROVIDER}"
echo " -b <nvme-backing-file> Emulated NVMe options."
echo " If no -b option is specified then this option defaults to emulating single" echo " If no -b option is specified then this option defaults to emulating single"
echo " NVMe with 1 namespace and assumes path: /var/lib/libvirt/images/nvme_disk.img" echo " NVMe with 1 namespace and assumes path: /var/lib/libvirt/images/nvme_disk.img"
echo " -c create all above disk, default 0" echo " -b option can be used multiple times for attaching multiple files to the VM"
echo " -s <ram-size> in kb default: ${SPDK_VAGRANT_VMRAM}" echo " Parameters for -b option: <path>,<type>,<namespaces>."
echo " -n <num-cpus> 1 to 4 default: ${SPDK_VAGRANT_VMCPU}" echo " Available types: nvme, ocssd."
echo " -x <http-proxy> default: \"${SPDK_VAGRANT_HTTP_PROXY}\"" echo " -c Create all above disk, default 0"
echo " -p <provider> libvirt or virtualbox" echo " -u Use password authentication to the VM instead of SSH keys."
echo " --qemu-emulator=<path> directory path with emulator, default: ${SPDK_QEMU_EMULATOR}" echo " -l Use a local copy of spdk, don't try to rsync from the host."
echo " --vagrantfiles-dir=<path> directory to put vagrantfile" echo " -d Deploy a test vm by provisioning all prerequisites for spdk autotest"
echo " -u allow password authentication to vagrant box" echo " --qemu-emulator=<path> Path to custom QEMU binary. Only works with libvirt provider"
echo " --package-box install all dependencies for SPDK and create local vagrant box" echo " --vagrantfiles-dir=<path> Destination directory to put Vagrantfile into."
echo " --package-box Install all dependencies for SPDK and create a local vagrant box version."
echo " -r dry-run" echo " -r dry-run"
echo " -l use a local copy of spdk, don't try to rsync from the host."
echo " -d deploy a test vm by provisioning all prerequisites for spdk autotest"
echo " -h help" echo " -h help"
echo " -v verbose" echo " -v verbose"
echo echo