Add comment to explain vbm function

As a wrapper around VBoxManage, vbm is a core function of the host-side
scripts, but it lacks a comment explaining what it does and how it is
used.

This patch adds that comment.

Partial-Bug: 1312764
Implements: blueprint openstack-training-labs
Change-Id: If3a0a13dd2dc83f031569cf8fc7cd9c604435321
This commit is contained in:
Roger Luethi 2014-06-17 19:25:15 +02:00
parent 238dcbc2b9
commit c31471f798

View File

@ -5,6 +5,10 @@
VBM=vbm
: ${VBM_LOG:=$LOG_DIR/vbm.log}
# vbm is a wrapper around the VirtualBox VBoxManage executable; it handles
# logging and conditional execution (set OSBASH= to prevent the actual call to
# VBoxManage, or WBATCH= to keep a call from being recorded for Windows batch
# files)
function vbm {
${WBATCH:-:} wbatch_log_vbm "$@"