SQSCANNER-70 - Updated script comments (#91)

diff --git a/src/main/assembly/bin/sonar-scanner b/src/main/assembly/bin/sonar-scanner
index 56f0ce55c39072cf50af96f214e849e048650453..2d2c2ccf6cd7a6c22b5e53bf076f841676864c2d 100755 (executable)
--- a/src/main/assembly/bin/sonar-scanner
+++ b/src/main/assembly/bin/sonar-scanner
@@ -2,10 +2,12 @@
 #
 # SonarScanner Startup Script for Unix
 #
+# Required ENV vars:
+#   JAVA_HOME - Location of Java's installation, optional if use_embedded_jre is set
+#
 # Optional ENV vars:
 #   SONAR_SCANNER_OPTS - Parameters passed to the Java VM when running the SonarScanner
 #   SONAR_SCANNER_DEBUG_OPTS - Extra parameters passed to the Java VM for debugging
-#   JAVA_HOME - Location of Java's installation
 
 real_path () {
   target=$1

diff --git a/src/main/assembly/bin/sonar-scanner-debug b/src/main/assembly/bin/sonar-scanner-debug
index 750f813cf804676b2f825035e7e8d7870bd6bd28..dd45ab0d3ddd8b7d7b3b5540f8ac3c7516e9f2e0 100755 (executable)
--- a/src/main/assembly/bin/sonar-scanner-debug
+++ b/src/main/assembly/bin/sonar-scanner-debug
@@ -2,9 +2,11 @@
 #
 # SonarScanner Startup Script for Unix
 #
+# Required ENV vars:
+#   JAVA_HOME - Location of Java's installation, optional if use_embedded_jre is set
+#
 # Optional ENV vars:
 #   SONAR_SCANNER_OPTS - parameters passed to the Java VM when running the SonarScanner
-#   JAVA_HOME - Location of Java's installation
 
 SONAR_SCANNER_DEBUG_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000"
 

diff --git a/src/main/assembly/bin/sonar-scanner-debug.bat b/src/main/assembly/bin/sonar-scanner-debug.bat
index aea4d9784eacf10163d1a577afb928eef411784b..3021c01b4b3ad65a6ca8c7689d44bcf0de978627 100644 (file)
--- a/src/main/assembly/bin/sonar-scanner-debug.bat
+++ b/src/main/assembly/bin/sonar-scanner-debug.bat
@@ -1,7 +1,7 @@
 @REM SonarScanner Startup Script for Windows
 @REM
 @REM Required ENV vars:
-@REM   JAVA_HOME - location of a JDK home dir
+@REM   JAVA_HOME - Location of Java's installation, optional if use_embedded_jre is set
 @REM
 @REM Optional ENV vars:
 @REM   SONAR_SCANNER_OPTS - parameters passed to the Java VM when running the SonarScanner

diff --git a/src/main/assembly/bin/sonar-scanner.bat b/src/main/assembly/bin/sonar-scanner.bat
index 4ee9e55ce22a06e7aba141b82df78bccc4ceafe3..fdfbfd9b09d78d6b576423e444377ba0852daa03 100644 (file)
--- a/src/main/assembly/bin/sonar-scanner.bat
+++ b/src/main/assembly/bin/sonar-scanner.bat
@@ -1,10 +1,11 @@
 @REM SonarScanner Startup Script for Windows
 @REM
 @REM Required ENV vars:
-@REM   JAVA_HOME - location of a JDK home dir
+@REM   JAVA_HOME - Location of Java's installation, optional if use_embedded_jre is set
 @REM
 @REM Optional ENV vars:
 @REM   SONAR_SCANNER_OPTS - parameters passed to the Java VM when running the SonarScanner
+@REM   SONAR_SCANNER_DEBUG_OPTS - Extra parameters passed to the Java VM for debugging
 
 @echo off