Skip to content

Commit 577b8c5

Browse files
authored
build: instruct AGENTS to run static analysis checks (#59137)
1 parent c9ef3a1 commit 577b8c5

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ If you made changes to the runtime (any files in `src/`), you will need to rebui
2727
julia. Run `make -j` to rebuild julia. This process may take up to 10 minutes
2828
depending on your changes.
2929

30+
After `make` run these static analysis checks:
31+
- `make -C src clang-sa-<filename>` (replace `<filename>` with the basename of the file you modified)
32+
- `make -C src clang-sagc-<filename>` which may require adding JL_GC_PUSH arguments, or JL_GC_PROMISE_ROOTED statements., or require fixing locks. Remember arguments are assumed rooted, so check the callers to make sure that is handled. If the value is being temporarily moved around in a struct or arraylist, `JL_GC_PROMISE_ROOTED(struct->field)` may be needed as a statement (it return void) immediately after reloading the struct before any use of struct. Put the promise as early in the code as is legal.
33+
- `make -C src clang-tidy-<filename>`
34+
3035
## Using Revise
3136

3237
If you have made changes to files included in the system image (base/ or stdlib/),

0 commit comments

Comments
 (0)