about summary refs log tree commit diff
path: root/src/doc
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2023-11-16 09:31:29 +0000
committerbors <bors@rust-lang.org>2023-11-16 09:31:29 +0000
commit255d04cd9bb6bb51d4586a288facd01ee23cbcbf (patch)
tree10b32a10a95d0ae65b6316dfc7931e6ab8ca30fd /src/doc
parent012bd49b8a60f02d504774293d7a381dfe74d5f4 (diff)
parent13bfe141ff5bb92901eea3e88432cda75a208b9f (diff)
downloadrust-255d04cd9bb6bb51d4586a288facd01ee23cbcbf.tar.gz
rust-255d04cd9bb6bb51d4586a288facd01ee23cbcbf.zip
Auto merge of #3167 - RalfJung:rustup, r=RalfJung
Rustup
Diffstat (limited to 'src/doc')
-rw-r--r--src/doc/unstable-book/src/compiler-flags/llvm-module-flag.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/doc/unstable-book/src/compiler-flags/llvm-module-flag.md b/src/doc/unstable-book/src/compiler-flags/llvm-module-flag.md
new file mode 100644
index 00000000000..454ad0a9a6d
--- /dev/null
+++ b/src/doc/unstable-book/src/compiler-flags/llvm-module-flag.md
@@ -0,0 +1,12 @@
+# `llvm-module-flag`
+
+---------------------
+
+This flag allows adding a key/value to the `!llvm.module.flags` metadata in the
+LLVM-IR for a compiled Rust module.  The syntax is
+
+`-Z llvm_module_flag=<name>:<type>:<value>:<behavior>`
+
+Currently only u32 values are supported but the type is required to be specified
+for forward compatibility.  The `behavior` element must match one of the named
+LLVM [metadata behaviors](https://llvm.org/docs/LangRef.html#module-flags-metadata)