From: Jean-Baptiste Lievremont Date: Tue, 8 Apr 2014 15:02:41 +0000 (+0200) Subject: SONAR-5171 Fix documentation strings for exclusion settings X-Git-Tag: 4.3~93 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=2e975e173f3c8f84657b8cce7b00f0f9b78ee05f;p=sonarqube.git SONAR-5171 Fix documentation strings for exclusion settings --- diff --git a/plugins/sonar-core-plugin/src/main/resources/org/sonar/l10n/core.properties b/plugins/sonar-core-plugin/src/main/resources/org/sonar/l10n/core.properties index 96db9a459fc..aff091a2fdd 100644 --- a/plugins/sonar-core-plugin/src/main/resources/org/sonar/l10n/core.properties +++ b/plugins/sonar-core-plugin/src/main/resources/org/sonar/l10n/core.properties @@ -909,7 +909,7 @@ property.sonar.global.exclusions.description=Patterns used to exclude some sourc property.sonar.global.test.exclusions.name=Global Test File Exclusions property.sonar.global.test.exclusions.description=Patterns used to exclude some test files from analysis. They apply to every project and cannot be overridden. property.category.exclusions.files=Files -property.category.exclusions.files.description=Configure which source code and tests you want to be omitted from analysis. Most of these parameters can also be configured at individual project level in each application's project settings. +property.category.exclusions.files.description=Configure the files that should be completely ignored by the analysis. property.sonar.skippedModules.name=Module Exclusions property.sonar.skippedModules.description=Comma-separated list of the modules to exclude from analysis.
\ If a module's artifactId differs from its module name (the directory name): it is the artifactId that should be use instead of the module name. @@ -917,11 +917,11 @@ property.sonar.includedModules.name=Module Inclusions property.sonar.includedModules.description=Comma-separated list of the modules to analyse, all other modules are automatically ignored. Be careful: the root project must be added to the list.
\ If a module's artifactId differs from its module name (the directory name): it is the artifactId that should be use instead of the module name. property.category.exclusions.issues=Issues -property.category.exclusions.issues.description=Configure which issues should not be reported. More information on the documentation page. +property.category.exclusions.issues.description=Configure the conditions under which issues should not be reported. property.category.exclusions.duplications=Duplications -property.category.exclusions.duplications.description=Configure files which should not be checked for duplicated code. +property.category.exclusions.duplications.description=Configure the files that should be ignored by duplication detection. property.category.exclusions.coverage=Code Coverage -property.category.exclusions.coverage.description=Configure files which should be considered for code coverage. +property.category.exclusions.coverage.description=Configure the files that should be ignored by code coverage calculations. property.sonar.coverage.exclusions.name=Coverage Exclusions property.sonar.coverage.exclusions.description=Patterns used to exclude some files from coverage report. property.category.technicalDebt=Technical Debt diff --git a/sonar-batch/src/main/java/org/sonar/batch/issue/ignore/IssueExclusionsConfiguration.java b/sonar-batch/src/main/java/org/sonar/batch/issue/ignore/IssueExclusionsConfiguration.java index d66c04ee0dc..18c2f9fa8b4 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/issue/ignore/IssueExclusionsConfiguration.java +++ b/sonar-batch/src/main/java/org/sonar/batch/issue/ignore/IssueExclusionsConfiguration.java @@ -43,6 +43,9 @@ public final class IssueExclusionsConfiguration { private static final String PROPERTY_FILE_PATH_PATTERN = "File Path Pattern"; public static final String RULE_KEY = "ruleKey"; private static final String PROPERTY_RULE_KEY_PATTERN = "Rule Key Pattern"; + private static final String PROPERTY_RULE_KEY_PATTERN_HELP = "
A rule key pattern consists of the rule repository name, followed by a colon, followed by a rule key " + + "or rule name fragment. For example:" + + ""; public static final String BLOCK_SUFFIX = ".block"; public static final String PATTERNS_BLOCK_KEY = EXCLUSION_KEY_PREFIX + BLOCK_SUFFIX; @@ -66,7 +69,7 @@ public final class IssueExclusionsConfiguration { .category(CoreProperties.CATEGORY_EXCLUSIONS) .subCategory(SUB_CATEGORY_IGNORE_ISSUES) .name("Ignore Issues on Multiple Criteria") - .description("Patterns to ignore issues on certain components and for certain coding rules.") + .description("Patterns to ignore issues on certain components and for certain coding rules." + PROPERTY_RULE_KEY_PATTERN_HELP) .onQualifiers(Qualifiers.PROJECT) .index(3) .fields( @@ -123,7 +126,7 @@ public final class IssueExclusionsConfiguration { .category(CoreProperties.CATEGORY_EXCLUSIONS) .subCategory(SUB_CATEGORY_IGNORE_ISSUES) .name("Restrict Scope of Coding Rules") - .description("Patterns to restrict the application of a rule to only certain components, ignoring all others.") + .description("Patterns to restrict the application of a rule to only certain components, ignoring all others." + PROPERTY_RULE_KEY_PATTERN_HELP) .onQualifiers(Qualifiers.PROJECT) .index(4) .fields(