From 956e42f0f363cd76b45a10e5b6890a17c943f446 Mon Sep 17 00:00:00 2001 From: sylvain-combe-sonarsource <59280694+sylvain-combe-sonarsource@users.noreply.github.com> Date: Mon, 6 Apr 2020 15:43:53 +0200 Subject: [PATCH] Remove uncommented properties filename from sample (#2682) * Remove uncommented properties filename from sample Small glitch in sonar-project.properties sample: it has as first line the name of the properties file. * Update sonarscanner.md As suggested by @ganncamp , fix the sample properties file in Alternate Analysis Directory section too. --- server/sonar-docs/src/pages/analysis/scan/sonarscanner.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/server/sonar-docs/src/pages/analysis/scan/sonarscanner.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner.md index e79e84c7fa5..984735abd80 100644 --- a/server/sonar-docs/src/pages/analysis/scan/sonarscanner.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner.md @@ -35,7 +35,6 @@ If you need more debug information you can add one of the following to your comm ## Use Create a configuration file in the root directory of the project: `sonar-project.properties` ``` -sonar-project.properties # must be unique in a given SonarQube instance sonar.projectKey=my:project @@ -75,14 +74,14 @@ Additional analysis parameters can be defined in this project configuration file ## Alternate Analysis Directory If the files to be analyzed are not in the directory where the analysis starts from, use the `sonar.projectBaseDir` property to move analysis to a different directory. E.G. analysis begins from `jenkins/jobs/myjob/workspace` but the files to be analyzed are in `ftpdrop/cobol/project1`. +This is configured in `sonar-project.properties` as follows: ``` -sonar-project.properties sonar.projectBaseDir=/home/ftpdrop/cobol/project1 sonar.sources=src sonar.cobol.copy.directories=/copy -For more, see the listing of analysis parameters. ``` +More parameters can be configured, see [Analysis Parameters](/analysis/analysis-parameters/) for details. ## Troubleshooting **Java heap space error or java.lang.OutOfMemoryError** -- 2.39.5