Skip to content

Commit 1d2b7c3

Browse files
committed
docs: document UNMANGLE, SKIPLANGSTART flags and test-skip-lang-start
1 parent 1fd19f1 commit 1d2b7c3

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ make png # Generate .png files in output-png/ (requires graphviz)
3737
make d2 # Generate .d2 files in output-d2/
3838
```
3939

40+
These targets accept optional flags that compose freely:
41+
42+
```shell
43+
make svg UNMANGLE=1 # Demangle symbol names in labels
44+
make svg SKIPLANGSTART=1 # Filter out std::rt::lang_start items
45+
make svg UNMANGLE=1 SKIPLANGSTART=1 # Both
46+
```
47+
4048
There are a few environment variables that can be set to control the tools output:
4149

4250
1. `LINK_ITEMS` - add entries to the link-time `functions` map for each monomorphic item in the crate;
@@ -71,7 +79,8 @@ These tests are stored [in `src/tests/integration/failing`](./src/tests/integrat
7179
To run the tests, do the following:
7280

7381
```shell
74-
make integration-test
82+
make integration-test # Golden-file JSON tests
83+
make test-skip-lang-start # Verify SKIP_LANG_START filtering works
7584
```
7685

7786
## Integration with `cargo`

0 commit comments

Comments
 (0)