From 84e898b620f8b60c90d15f252ee270aefadc91e6 Mon Sep 17 00:00:00 2001
From: Roger Luethi <rl@patchworkscience.org>
Date: Sun, 24 Aug 2014 11:45:08 +0200
Subject: [PATCH] labs: comments for get_vb_version

Add some comments to get_vb_version.

Change-Id: I049a82956674544a0096fcadf5e23120c076672f
---
 labs/lib/osbash/virtualbox.functions | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/labs/lib/osbash/virtualbox.functions b/labs/lib/osbash/virtualbox.functions
index cc8b0b74..4e72c011 100644
--- a/labs/lib/osbash/virtualbox.functions
+++ b/labs/lib/osbash/virtualbox.functions
@@ -27,9 +27,12 @@ function vbm {
     fi
 }
 
+# Return VirtualBox version string (without distro extensions)
 function get_vb_version {
     local VERSION=""
+    # e.g. 4.1.32r92798 4.3.10_RPMFusionr93012 4.3.10_Debianr93012
     local RAW=$(WBATCH= $VBM --version)
+    # Sanitize version string
     local re='([0-9]+\.[0-9]+\.[0-9]+).*'
     if [[ $RAW =~ $re ]]; then
         VERSION=${BASH_REMATCH[1]}
@@ -483,8 +486,8 @@ function vm_rm_share {
 # VirtualBox guest add-ons
 #-------------------------------------------------------------------------------
 
+# Download VirtualBox guest-additions. Returns local path of ISO image.
 function _download_guestadd-iso {
-    # e.g. 4.1.32r92798 4.3.10_RPMFusionr93012 4.3.10_Debianr93012
     local ISO=VBoxGuestAdditions.iso
     local VER=$(get_vb_version)
     if [[ -n "$VER" ]]; then