diff --git a/README.adoc b/README.adoc index 4477f32398..dc146a833b 100644 --- a/README.adoc +++ b/README.adoc @@ -156,18 +156,18 @@ And finally, merge the rule implementation in your analyzer repository. ==== Generate/Update rule metadata for the analyzer * Download the last version of https://github.com/SonarSource/sonar-rule-api[rule-api]. -* call `gh_generate` if you are adding a rule, or `gh_update` if you just want the last specification version. +* call `generate` if you are adding a rule, or `update` if you just want the last specification version. Example: [source,shell] ---- -$ java -jar rule-api-1.24.3.jar gh_generate -rule S4328 +$ java -jar rule-api-1.24.3.jar generate -rule S4328 # or -$ java -jar rule-api-1.24.3.jar gh_update +$ java -jar rule-api-1.24.3.jar update ---- NOTE: If you generate rules in an empty directory, -you have to run `gh_update` immediately after, +you have to run `update` immediately after, because rule-api relies on the files in the directory to determine the covered set of rules when generating the deprecation notes for superseded rules.