From 57c14e9af1edd4cca3b38859d87d0cf040de2dcb Mon Sep 17 00:00:00 2001
From: Shital Savekar <iamshital@outlook.com>
Date: Thu, 31 May 2018 01:25:47 -0700
Subject: [PATCH] Added comments to TestParameters.sh

---
 Utilities/TestParameters.sh | 95 ++++++++++++++++++++++---------------
 1 file changed, 57 insertions(+), 38 deletions(-)

diff --git a/Utilities/TestParameters.sh b/Utilities/TestParameters.sh
index 13d58c6ec..9c003d887 100644
--- a/Utilities/TestParameters.sh
+++ b/Utilities/TestParameters.sh
@@ -4,50 +4,69 @@
 #Paramerers file for LaunchTestPipelineRemotely.sh
 ##################################################
 
-#Required
+#Required (Your jenkins username)
+#This will be used to login jenkins in conjuction with ApiToken
 JenkinsUser=""
 
-#Optinal
-UpstreamBuildNumber=""
 
-#Required any one of the following
-ImageSource=""
-CustomVHD=""
-CustomVHDURL=""
-
-#Required
-Kernel="default"
-
-#Required any of the following if Kernel=custom
-CustomKernelFile=""
-CustomKernelURL=""
-
-#Required
-GitUrlForAutomation="https://github.com/LIS/LISAv2.git"
-
-#Required
-GitBranchForAutomation="master"
-
-#Required at least one test selection choise from following.
-TestByTestname=""
-TestByCategorisedTestname=""
-TestByCategory=""
-TestByTag=""
-
-#Required
-Email=""
-
-#Required
-LinuxUsername=""
-LinuxPassword=""
-
-#Required to access Jenkins.
+#Required (You can generate your access token in the jenkins.)
 ApiToken=""
 
-#Required to upload Files to jenkins server using FTP
+
+#Required only if you are uploading files from your local machine to Jenkins. These credentials are different from Jenkins username/password. 
 FtpUsername=""
 FtpPassword=""
 
+
+#Required (Image / VHD under test)
+#Provide ONLY ONE of the following.
+ImageSource=""
+#Example ImageSource="Publisher Offer Sku Version"
+CustomVHD=""
+#Example CustomVHD="/path/to/local/vhd/vhdx/vhd.xz file"
+CustomVHDURL=""
+#Example CustomVHDURL="http://downloadable/link/to/your/file.vhd/vhdx/vhd.xz"
+
+
+#Required (This kernel be installed before starting test)
+Kernel=""
+#Example Kernel="default/custom/linuxnext"
+
+
+#Required ONLY IF you set Kernel=custom
+CustomKernelFile=""
+#Example CustomKernelFile="/path/to/local/kernel/file.rpm/file.deb"
+CustomKernelURL=""
+#Example CustomKernelURL="http://downloadable/link/to/your/kernel.rpm/kernel.deb"
+
+
+#Required (Source code for tests)
+GitUrlForAutomation="https://github.com/LIS/LISAv2.git"
 #Required
-#TestPipeline="/Microsoft/job/Microsoft-Test-Execution-Pipeline"
-TestPipeline=""
\ No newline at end of file
+GitBranchForAutomation="master"
+
+
+#Required AT LEAST ONE test selection choise from following.
+#Multiple tests can be submitted using comma separated values
+TestByTestname=""
+#Example TestByTestname="Azure>>VERIFY-DEPLOYMENT-PROVISION>>eastasia,Azure>>VERIFY-HOSTNAME>>westeurope"
+TestByCategorisedTestname=""
+#Example TestByCategorisedTestname="Azure>>Smoke>>default>>VERIFY-DEPLOYMENT-PROVISION>>northeurope,Azure>>Functional>>SRIOV>>VERIFY-SRIOV-LSPCI>>southcentralus"
+TestByCategory=""
+#Example TestByCategory="Azure>>Functional>>SRIOV>>eastus,Azure>>Community>>LTP>>westeurope"
+TestByTag=""
+#Example TestByTag="Azure>>boot>>northcentralus,Azure>>wala>>westeurope,Azure>>gpu>>eastus"
+
+
+#Required (Email will be sent to these email addresses. Comma separated email IDs are accepted.
+Email=""
+
+
+#Required (These credential be used to create your test VMs. In case of debugging, you can use this to login to test VM.)
+LinuxUsername=""
+LinuxPassword=""
+
+
+#Required (Your pipeline name)
+TestPipeline=""
+#Example TestPipeline="<PatnerName>-Test-Execution-Pipeline"
\ No newline at end of file