libs-code/tree-sitter.tree-sitter
1
0
Fork 0
mirror of https://github.com/tree-sitter/tree-sitter.git synced 2026-09-10 07:26:23 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: document parser library symbol checks for build command

Browse source
This commit is contained in:
Will Lillis 2026-01-25 15:15:13 -05:00
parent c0137208ec
commit 8816d4494f
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/src/cli/build.md
View file

@ -14,6 +14,17 @@ minimum supported version.
The path argument allows you to specify the directory of the parser to build. If you don't supply this argument, the CLI
will attempt to build the parser in the current working directory.
On Unix platforms, the CLI will attempt to use `nm` to validate the symbols included in your parser library. Note that this
safety check is _not_ performed on Windows. If performed, this check ensures that:
- All non tree-sitter functions are marked static, to avoid conflicts when building with another tree-sitter project
- If an external scanner is used by your parser, all of the following symbols are present:
- `tree_sitter_<name>_external_scanner_create`
- `tree_sitter_<name>_external_scanner_destroy`
- `tree_sitter_<name>_external_scanner_serialize`
- `tree_sitter_<name>_external_scanner_deserialize`
- `tree_sitter_<name>_external_scanner_scan`
## Options
### `-w/--wasm`