openharmony/third_party_rust_clang-sys
1
0
Fork 0
mirror of https://github.com/openharmony/third_party_rust_clang-sys.git synced 2026-07-01 09:24:14 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add note about EntityKind breaking change

Browse Source
This commit is contained in:
Kyle Mayes
2022-09-22 05:38:35 -04:00
parent a0fdbea421
commit 40d974ecd5
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2
View File
@@ -31,6 +31,8 @@ To target a version of `libclang`, enable a Cargo features such as one of the fo
If you do not enable one of these features, the API provided by `libclang` 3.5 will be available by default.
**Note:** If you are using Clang 15.0 or later, you should enable the `clang_15_0` feature or a more recent version feature. Clang 15.0 introduced [a breaking change to the `EntityKind` enum](https://github.com/llvm/llvm-project/commit/bb83f8e70bd1d56152f02307adacd718cd67e312#diff-674613a0e47f4e66cc19061e28e3296d39be2d124dceefb68237b30b8e241e7c) which resulted in a mismatch between the values returned by `libclang` and the values for `EntityKind` defined by this crate in previous versions.
## Dependencies
By default, this crate will attempt to link to `libclang` dynamically. In this case, this crate depends on the `libclang` shared library (`libclang.so` on Linux, `libclang.dylib` on macOS, `libclang.dll` on Windows). If you want to link to `libclang` statically instead, enable the `static` Cargo feature. In this case, this crate depends on the LLVM and Clang static libraries. If you don't want to link to `libclang` at compiletime but instead want to load it at runtime, enable the `runtime` Cargo feature.