Skip to content

Commit 5e85426

Browse files
authored
Merge pull request #46 from rvermeulen/rvermeulen/fix-user-manual
Address incorrect package file generation command
2 parents d2e0cbc + c808ef4 commit 5e85426

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
@@ -31,6 +31,7 @@
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. |
3333
| 0.25.0 | 2022-07-22 | Jeroen Ketema | Document the existence and purpose of the `next` branch. |
34+
| 0.26.0 | 2022-08-10 | Remco Vermeulen | Address incorrect package file generation command. This was missing the required language argument. |
3435

3536
## Scope of work
3637

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

264265
```
265-
python3.9 scripts/generate_rules/generate_package_files.py <rule_package_name>
266+
python3.9 scripts/generate_rules/generate_package_files.py <language> <rule_package_name>
266267
```
267268

268269
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:
269270

270271
```
271-
python3.9 scripts/generate_rules/generate_package_files.py --external-help-dir <codeql_coding_standards_help_path> <rule_package_name>
272+
python3.9 scripts/generate_rules/generate_package_files.py --external-help-dir <codeql_coding_standards_help_path> <language> <rule_package_name>
272273
```
273274

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

0 commit comments

Comments
 (0)