diff options
| author | Xavier Claessens <xavier.claessens@collabora.com> | 2023-10-10 11:07:22 -0400 |
|---|---|---|
| committer | Xavier Claessens <xclaesse@gmail.com> | 2024-10-11 17:16:30 -0400 |
| commit | 304207b9d26fc8c2450e15af7260e850cbe97189 (patch) | |
| tree | 59417f4ed237ed1357726b873bcda254cd46ede6 /docs/markdown | |
| parent | 842504d6143d0820c5467db93fa1f004fd241157 (diff) | |
| download | meson-304207b9d26fc8c2450e15af7260e850cbe97189.tar.gz | |
cargo: Document that cargo subprojects is an experimental feature
Diffstat (limited to 'docs/markdown')
| -rw-r--r-- | docs/markdown/Wrap-dependency-system-manual.md | 6 | ||||
| -rw-r--r-- | docs/markdown/snippets/cargo_exp.md | 8 |
2 files changed, 14 insertions, 0 deletions
diff --git a/docs/markdown/Wrap-dependency-system-manual.md b/docs/markdown/Wrap-dependency-system-manual.md index 9bb7a8426..d84e4aa18 100644 --- a/docs/markdown/Wrap-dependency-system-manual.md +++ b/docs/markdown/Wrap-dependency-system-manual.md @@ -297,6 +297,9 @@ fallback to use the subproject, assuming it uses ### CMake wraps +**Note**: This is experimental and has no backwards or forwards compatibility guarantees. +See [Meson's rules on mixing build systems](Mixing-build-systems.md). + Since the CMake module does not know the public name of the provided dependencies, a CMake `.wrap` file cannot use the `dependency_names = foo` syntax. Instead, the `dep_name = <target_name>_dep` syntax should be used, where @@ -316,6 +319,9 @@ foo-bar-1.0 = foo_bar_dep ``` ### Cargo wraps +**Note**: This is experimental and has no backwards or forwards compatibility guarantees. +See [Meson's rules on mixing build systems](Mixing-build-systems.md). + Cargo subprojects automatically override the `<package_name>-<version>-rs` dependency name: - `package_name` is defined in `[package] name = ...` section of the `Cargo.toml`. diff --git a/docs/markdown/snippets/cargo_exp.md b/docs/markdown/snippets/cargo_exp.md new file mode 100644 index 000000000..34d379a70 --- /dev/null +++ b/docs/markdown/snippets/cargo_exp.md @@ -0,0 +1,8 @@ +## Cargo subprojects is experimental + +Cargo subprojects was intended to be experimental with no stability guarantees. +That notice was unfortunately missing from documentation. Meson will now start +warning about usage of experimental features and future releases might do breaking +changes. + +This is aligned with our general policy regarding [mixing build systems](Mixing-build-systems.md). |
