From: Vratko Polak <vrpolak@cisco.com>
Date: Tue, 23 Jul 2019 11:00:04 +0000 (+0200)
Subject: Update documentation of select_arch_os
X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=commitdiff_plain;h=674dc2fb96dc418f3bbae92aaff5431edbef1fea

Update documentation of select_arch_os

Change-Id: I619a18918b0710a59a3b36283aa79da06d640fae
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
---

diff --git a/resources/libraries/bash/function/common.sh b/resources/libraries/bash/function/common.sh
index 89c8f31914..f7a7a004df 100644
--- a/resources/libraries/bash/function/common.sh
+++ b/resources/libraries/bash/function/common.sh
@@ -650,14 +650,11 @@ function run_pybot () {
 
 function select_arch_os () {
 
-    # Populate variables related to local operating system.
-    #
-    # Also install any missing prerequisities CSIT tests need.
-    # TODO: Move the installation to a separate function?
+    # Set variables affected by local CPU architecture and operating system.
     #
     # Variables set:
-    # - VPP_VER_FILE - Name of File in CSIT dir containing vpp stable version.
-    # - IMAGE_VER_FILE - Name of File in CSIT dir containing the image name.
+    # - VPP_VER_FILE - Name of file in CSIT dir containing vpp stable version.
+    # - IMAGE_VER_FILE - Name of file in CSIT dir containing the image name.
     # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
 
     set -exuo pipefail