aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMark Rekveld <mark.rekveld@sonarsource.com>2020-09-28 08:55:34 +0200
committerGitHub <noreply@github.com>2020-09-28 08:55:34 +0200
commit22b155a580d6ac9d09e15259afd92e4e853c7799 (patch)
tree964b4fc8d3406a9fa511fdd6ee28b070c156f9d1
parent95134f6c3d3b66c24196ec08d2c15f3e4880aa93 (diff)
downloadsonar-scanner-cli-22b155a580d6ac9d09e15259afd92e4e853c7799.tar.gz
sonar-scanner-cli-22b155a580d6ac9d09e15259afd92e4e853c7799.zip
SQSCANNER-70 - Updated script comments (#91)
-rwxr-xr-xsrc/main/assembly/bin/sonar-scanner4
-rwxr-xr-xsrc/main/assembly/bin/sonar-scanner-debug4
-rw-r--r--src/main/assembly/bin/sonar-scanner-debug.bat2
-rw-r--r--src/main/assembly/bin/sonar-scanner.bat3
4 files changed, 9 insertions, 4 deletions
diff --git a/src/main/assembly/bin/sonar-scanner b/src/main/assembly/bin/sonar-scanner
index 56f0ce5..2d2c2cc 100755
--- 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 750f813..dd45ab0 100755
--- 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 aea4d97..3021c01 100644
--- 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 4ee9e55..fdfbfd9 100644
--- 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