From c31471f798a7dfc75d28a399751362f9cfaa96f1 Mon Sep 17 00:00:00 2001
From: Roger Luethi <rl@patchworkscience.org>
Date: Tue, 17 Jun 2014 19:25:15 +0200
Subject: [PATCH] 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
---
 labs/lib/osbash/virtualbox.functions | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/labs/lib/osbash/virtualbox.functions b/labs/lib/osbash/virtualbox.functions
index 715a2ad0..f73687aa 100644
--- a/labs/lib/osbash/virtualbox.functions
+++ b/labs/lib/osbash/virtualbox.functions
@@ -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 "$@"