aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorG. Ann Campbell <ann.campbell@sonarsource.com>2019-04-17 15:19:26 -0400
committersonartech <sonartech@sonarsource.com>2019-04-23 10:37:57 +0200
commitee9a724c1b7772c419fbd009a0bd58c1d3234bdc (patch)
treeae440ce73da8508fc4747bec00a37fb8c81b4ed6
parent58bb4b37da6e32a113870b0fc98d5494379641b6 (diff)
downloadsonarqube-ee9a724c1b7772c419fbd009a0bd58c1d3234bdc.tar.gz
sonarqube-ee9a724c1b7772c419fbd009a0bd58c1d3234bdc.zip
DOC update intro to Analysis Params
-rw-r--r--server/sonar-docs/src/pages/analysis/analysis-parameters.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/server/sonar-docs/src/pages/analysis/analysis-parameters.md b/server/sonar-docs/src/pages/analysis/analysis-parameters.md
index c97e91838aa..f2714843e02 100644
--- a/server/sonar-docs/src/pages/analysis/analysis-parameters.md
+++ b/server/sonar-docs/src/pages/analysis/analysis-parameters.md
@@ -3,21 +3,24 @@ title: Analysis Parameters
url: /analysis/analysis-parameters/
---
-Parameters to configure project analysis can be set in multiple places. Here is the hierarchy of parameters:
+## Table of Contents
+
+Project analysis settings can be configured in multiple places. Here is the hierarchy:
<!-- sonarqube -->
-* Global analysis parameters, defined in the UI, apply to all the projects (From the top bar, go to **[Administration > Configuration > General Settings](/#sonarqube-admin#/admin/settings)**)
+* Global properties, defined in the UI, apply to all projects (From the top bar, go to **[Administration > Configuration > General Settings](/#sonarqube-admin#/admin/settings)**)
<!-- /sonarqube -->
-* Project analysis parameters, defined in the UI, override global parameters (At a project level, go to **Administration > General Settings**)
+* Project properties, defined in the UI, override global property values (At a project level, go to **Administration > General Settings**)
* Project analysis parameters, defined in a project analysis configuration file or an analyzer configuration file, override the ones defined in the UI
-* Analysis / Command line parameters, defined when launching an analysis, override project analysis parameters
+* Analysis / Command line parameters, defined when launching an analysis (with `-D` on the command line), override project analysis parameters
Note that only parameters set through the UI are stored in the database.
-For example, if you override the `sonar.exclusions` parameter via command line for a specific project, it will not be stored in the database. Analyses in SonarLint with connected mode, for example, would still be executed with the exclusions defined in the UI and therefore stored in the DB.
+For example, if you override the `sonar.exclusions` parameter via command line for a specific project, it will not be stored in the database. Subsequent analyses, or analyses in SonarLint with connected mode, would still be executed with the exclusions defined in the UI and therefore stored in the DB.
-Note also that the list of parameters below is not exhaustive. Most of the property keys shown in the interface, at both global and project levels, can also be set as analysis parameters. However, exclusions/inclusions are far easier to manage in the UI.
+Most of the property keys shown in the interface at both global and project levels can also be set as analysis parameters, but the parameters listed below can _only_ be set at analysis time.
-For language-specific parameters related to test coverage and execution, see [Test Coverage & Execution](/analysis/coverage/). For language-specific parameters related to external issue reports, see [External Issues)(/analysis/external-issues).
+For language-specific parameters related to test coverage and execution, see [Test Coverage & Execution](/analysis/coverage/).
+For language-specific parameters related to external issue reports, see [External Issues)(/analysis/external-issues).
## Mandatory Parameters