aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorXavier Claessens <xavier.claessens@collabora.com>2023-04-21 16:21:48 -0400
committerXavier Claessens <xclaesse@gmail.com>2023-09-19 13:54:49 -0400
commit10dcd87d002f6f36b1f60371dc807b8d9959d97b (patch)
tree676b5597a7accdd4e2853d7c53f3453535dc5727 /docs
parent8ccdb881374084ddb90ef259539cfd3bb748c904 (diff)
downloadmeson-10dcd87d002f6f36b1f60371dc807b8d9959d97b.zip
meson-10dcd87d002f6f36b1f60371dc807b8d9959d97b.tar.gz
meson-10dcd87d002f6f36b1f60371dc807b8d9959d97b.tar.bz2
Rust: Replace rust_crate_type with rust_abi
Meson already knows if it's a shared or static library, user only need to specify the ABI (Rust or C).
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/snippets/rust_crate_type.md11
-rw-r--r--docs/yaml/functions/_build_target_base.yaml5
-rw-r--r--docs/yaml/functions/library.yaml11
-rw-r--r--docs/yaml/functions/shared_library.yaml8
-rw-r--r--docs/yaml/functions/shared_module.yaml8
-rw-r--r--docs/yaml/functions/static_library.yaml8
6 files changed, 51 insertions, 0 deletions
diff --git a/docs/markdown/snippets/rust_crate_type.md b/docs/markdown/snippets/rust_crate_type.md
new file mode 100644
index 0000000..9b32f0e
--- /dev/null
+++ b/docs/markdown/snippets/rust_crate_type.md
@@ -0,0 +1,11 @@
+## Deprecated `rust_crate_type` and replaced by `rust_abi`
+
+The new `rust_abi` keyword argument is accepted by [[shared_library]],
+[[static_library]], [[library]] and [[shared_module]] functions. It can be either
+`'rust'` (the default) or `'c'` strings.
+
+`rust_crate_type` is now deprecated because Meson already knows if it's a shared
+or static library, user only need to specify the ABI (Rust or C).
+
+`proc_macro` crates are now handled by the [`rust.proc_macro()`](Rust-module.md#proc_macro)
+method.
diff --git a/docs/yaml/functions/_build_target_base.yaml b/docs/yaml/functions/_build_target_base.yaml
index 724b6a4..3f0e881 100644
--- a/docs/yaml/functions/_build_target_base.yaml
+++ b/docs/yaml/functions/_build_target_base.yaml
@@ -289,6 +289,7 @@ kwargs:
rust_crate_type:
type: str
since: 0.42.0
+ deprecated: 1.3.0
description: |
Set the specific type of rust crate to compile (when compiling rust).
@@ -306,6 +307,10 @@ kwargs:
"proc-macro" is new in 0.62.0.
+ *Since 1.3.0* this is deprecated and replaced by "rust_abi" keyword argument.
+ `proc_macro` crates are now handled by the [`rust.proc_macro()`](Rust-module.md#proc_macro)
+ method.
+
rust_dependency_map:
type: dict[str]
since: 1.2.0
diff --git a/docs/yaml/functions/library.yaml b/docs/yaml/functions/library.yaml
index f10ef8e..f9e336b 100644
--- a/docs/yaml/functions/library.yaml
+++ b/docs/yaml/functions/library.yaml
@@ -21,3 +21,14 @@ varargs_inherit: _build_target_base
kwargs_inherit:
- shared_library
- static_library
+
+kwargs:
+ rust_abi:
+ type: str
+ since: 1.3.0
+ description: |
+ Set the specific ABI to compile (when compiling rust).
+ - 'rust' (default): Create a "rlib" or "dylib" crate depending on the library
+ type being build.
+ - 'c': Create a "cdylib" or "staticlib" crate depending on the library
+ type being build.
diff --git a/docs/yaml/functions/shared_library.yaml b/docs/yaml/functions/shared_library.yaml
index 956fb2c..5076b93 100644
--- a/docs/yaml/functions/shared_library.yaml
+++ b/docs/yaml/functions/shared_library.yaml
@@ -44,3 +44,11 @@ kwargs:
description: |
Specify a Microsoft module definition file for controlling symbol exports,
etc., on platforms where that is possible (e.g. Windows).
+
+ rust_abi:
+ type: str
+ since: 1.3.0
+ description: |
+ Set the specific ABI to compile (when compiling rust).
+ - 'rust' (default): Create a "dylib" crate.
+ - 'c': Create a "cdylib" crate.
diff --git a/docs/yaml/functions/shared_module.yaml b/docs/yaml/functions/shared_module.yaml
index 20bd5c4..46086ba 100644
--- a/docs/yaml/functions/shared_module.yaml
+++ b/docs/yaml/functions/shared_module.yaml
@@ -39,3 +39,11 @@ kwargs:
description: |
Specify a Microsoft module definition file for controlling symbol exports,
etc., on platforms where that is possible (e.g. Windows).
+
+ rust_abi:
+ type: str
+ since: 1.3.0
+ description: |
+ Set the specific ABI to compile (when compiling rust).
+ - 'rust' (default): Create a "dylib" crate.
+ - 'c': Create a "cdylib" crate.
diff --git a/docs/yaml/functions/static_library.yaml b/docs/yaml/functions/static_library.yaml
index 1d42d60..615baa2 100644
--- a/docs/yaml/functions/static_library.yaml
+++ b/docs/yaml/functions/static_library.yaml
@@ -23,3 +23,11 @@ kwargs:
If `true` the object files in the target will be prelinked,
meaning that it will contain only one prelinked
object file rather than the individual object files.
+
+ rust_abi:
+ type: str
+ since: 1.3.0
+ description: |
+ Set the specific ABI to compile (when compiling rust).
+ - 'rust' (default): Create a "rlib" crate.
+ - 'c': Create a "staticlib" crate.