Modify rule S3541: Deprecate the rule (CPP-5904) (#4559)

Also improve documentation of the deprecation process.
SonarSource · Dec 11, 2024 · 5675385 · 5675385
1 parent 62c1e32
commit 5675385
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 9 deletions.
diff --git a/docs/deprecation.adoc b/docs/deprecation.adoc
@@ -2,7 +2,7 @@
 
 == In the RSPEC
 
-The rule status (`/status` in the metadata) should be set to `deprecated`.
+The rule status (`/status` in the metadata) should be set to `deprecated`, and its tags should be removed. If the rule is in `SonarWay`, it should be removed from this profile.
 
 Optionally, `/extra/replacementRules` can list the rules that replace this rule.
 

diff --git a/rules/S3541/cfamily/metadata.json b/rules/S3541/cfamily/metadata.json
@@ -7,15 +7,12 @@
     },
     "attribute": "CLEAR"
   },
-  "status": "ready",
+  "status": "deprecated",
   "remediation": {
     "func": "Constant\/Issue",
     "constantCost": "2min"
   },
-  "tags": [
-    "redundant",
-    "clumsy"
-  ],
+  "tags": [],
   "extra": {
     "replacementRules": [
 
@@ -28,8 +25,6 @@
   "ruleSpecification": "RSPEC-3541",
   "sqKey": "S3541",
   "scope": "Main",
-  "defaultQualityProfiles": [
-    "Sonar way"
-  ],
+  "defaultQualityProfiles": [],
   "quickfix": "unknown"
 }