From 1bd3ddaa751c81b4c09ef89f06fab363e25a56c5 Mon Sep 17 00:00:00 2001
From: Dominik Stadler <centic@apache.org>
Date: Sun, 1 Nov 2020 09:21:29 +0000
Subject: [PATCH] Add comments for Sonar properties in the Gradle build

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1883036 13f79535-47bb-0310-9956-ffa450edef68
---
 build.gradle | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/build.gradle b/build.gradle
index d964dd2363..97ee04ad47 100644
--- a/build.gradle
+++ b/build.gradle
@@ -180,11 +180,18 @@ subprojects {
     projectDir.mkdirs()
 
     if (project.hasProperty('enableSonar')) {
+        // See https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-gradle/ and
+        // https://docs.sonarqube.org/display/SONARQUBE52/Analyzing+with+SonarQube+Scanner+for+Gradle
+        // for documentation of properties.
+        //
+        // Some additional properties are currently set in the Jenkins-DSL, see jenksin/create_jobs.groovy
+        //
         sonarqube {
             properties {
                 // as we currently use build/<module>/ as project-basedir, we need to tell Sonar to use
                 // the root-folder as "basedir" for the projects
                 property "sonar.projectBaseDir", "$projectDir/../.."
+                // currently supported providers on Jenkins: "hg,git": property "sonar.scm.provider", "svn"
 
                 // the plugin seems to not detect our non-standard build-layout
                 property "sonar.junit.reportPaths", "$projectDir/build/test-results/test"