ishangsf/rspec
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
Also improve documentation of the deprecation process.
This commit is contained in:
Loïc Joly 2024-12-11 11:30:05 +01:00 committed by GitHub
parent 62c1e322df
commit 5675385d6b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/deprecation.adoc
View File

@ -2,7 +2,7 @@
== In the RSPEC == 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. Optionally, `/extra/replacementRules` can list the rules that replace this rule.

11
rules/S3541/cfamily/metadata.json
View File

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