Skip to content

Commit 657b539

Browse files
authored
Fix typo in package names
1 parent 53b21c4 commit 657b539

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/user_manual.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,13 +238,13 @@ Reference: [CodeQL CLI: Creating a CodeQL database](https://codeql.github.com/do
238238
Once you have a CodeQL database for your project you can run the default analysis for a specified Coding Standard using the `codeql database analyze` command by specifying the names of the QL packs which you want to run as arguments, along with a version specifier:
239239

240240
```bash
241-
codeql database analyze --format=sarifv2.1.0 --output=<name-of-results-file>.sarif path/to/<output_database_name> codeql/<standard>-<language>-coding-standard@version
241+
codeql database analyze --format=sarifv2.1.0 --output=<name-of-results-file>.sarif path/to/<output_database_name> codeql/<standard>-<language>-coding-standards@version
242242
```
243243

244244
For example, this command would run MISRA C and CERT C with the default query sets:
245245

246246
```bash
247-
codeql database analyze --format=sarifv2.1.0 --output=results.sarif path/to/<output_database_name> codeql/misra-c-coding-standard@version codeql/cert-c-coding-standard@version
247+
codeql database analyze --format=sarifv2.1.0 --output=results.sarif path/to/<output_database_name> codeql/misra-c-coding-standards@version codeql/cert-c-coding-standards@version
248248
```
249249
The output of this command will be a [SARIF file](https://sarifweb.azurewebsites.net/) called `<name-of-results-file>.sarif`.
250250

@@ -262,13 +262,13 @@ Alternatively, the packs can be made available to CodeQL without specification o
262262
Each supported standard includes a variety of query suites, which enable the running of different sets of queries based on specified properties. In addition, a custom query suite can be defined as specified by the CodeQL CLI documentation, in order to select any arbitrary sets of queries in this repository. To run
263263

264264
```bash
265-
codeql database analyze --format=sarifv2.1.0 --output=<name-of-results-file>.sarif path/to/<output_database_name> codeql/<standard>-<language>-coding-standard@version:codeql-suites/<alternative-suite>.qls
265+
codeql database analyze --format=sarifv2.1.0 --output=<name-of-results-file>.sarif path/to/<output_database_name> codeql/<standard>-<language>-coding-standards@version:codeql-suites/<alternative-suite>.qls
266266
```
267267

268268
If modifying the query suite, ensure that all Rules you expect to be covered by CodeQL in your Guideline Enforcement Plan (or similar) are included in the query suite, by running:
269269

270270
```bash
271-
codeql resolve queries codeql/<standard>-<language>-coding-standard@version:codeql-suites/<alternative-suite>.qls
271+
codeql resolve queries codeql/<standard>-<language>-coding-standards@version:codeql-suites/<alternative-suite>.qls
272272
```
273273

274274
##### Supported SARIF versions

0 commit comments

Comments
 (0)