Skip to content

Commit 0f33654

Browse files
committed
Address incorrect package file generation command
The documented command missed the required language argument.
1 parent 2122a3d commit 0f33654

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/development_handbook.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
| 0.22.0 | 2022-07-05 | Remco Vermeulen | Update section `Generation of query templates from rule specifications` to include external help files. |
3131
| 0.23.0 | 2022-07-05 | Remco Vermeulen | Update text to consider both the C++ and the C standards. |
3232
| 0.24.0 | 2022-07-05 | Remco Vermeulen | Update release process to include steps for external help files. |
33+
| 0.25.0 | 2022-08-10 | Remco Vermeulen | Address incorrect package file generation command. This was missing the required language argument. |
3334

3435
## Scope of work
3536

@@ -261,13 +262,13 @@ Ensure that the repository [codeql-coding-standards-help](https://github.com/git
261262
To generate the rule package files, run the following script from the root of the repository:
262263

263264
```
264-
python3.9 scripts/generate_rules/generate_package_files.py <rule_package_name>
265+
python3.9 scripts/generate_rules/generate_package_files.py <language> <rule_package_name>
265266
```
266267

267268
If the repository [codeql-coding-standards-help](https://github.com/github/codeql-coding-standards-help) is not cloned as a sibling, then run the script as follows:
268269

269270
```
270-
python3.9 scripts/generate_rules/generate_package_files.py --external-help-dir <codeql_coding_standards_help_path> <rule_package_name>
271+
python3.9 scripts/generate_rules/generate_package_files.py --external-help-dir <codeql_coding_standards_help_path> <language> <rule_package_name>
271272
```
272273

273274
After running this script, the following files will be generated in the `<lang>/<standard>/src/rules/<rule-id>/` directory:

0 commit comments

Comments
 (0)