about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorJakub Beránek <berykubik@gmail.com>2025-02-20 21:34:11 +0100
committerJakub Beránek <berykubik@gmail.com>2025-03-31 09:44:41 +0200
commita5057b786b1f6fd04c4b590ea7eb160e36c281db (patch)
tree6ad45200e890f6de3bddaf672b7722efd6d94c6f /src
parent9800eb2cabd962ff1899e94841b15ca9dc874528 (diff)
Add documentation of the option into the unstable book
Diffstat (limited to 'src')
-rw-r--r--src/doc/unstable-book/src/compiler-flags/embed-metadata.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/doc/unstable-book/src/compiler-flags/embed-metadata.md b/src/doc/unstable-book/src/compiler-flags/embed-metadata.md
new file mode 100644
index 00000000000..a2a790ee76a
--- /dev/null
+++ b/src/doc/unstable-book/src/compiler-flags/embed-metadata.md
@@ -0,0 +1,3 @@
+## `embed-metadata`
+
+This option instructs `rustc` to include the full metadata in `rlib` and `dylib` crate types. The default value is `yes` (enabled). If disabled (`no`), only stub metadata will be stored in these files, to reduce their size on disk. When using `-Zembed-metadata=no`, you will probably want to use `--emit=metadata` to produce the full metadata into a separate `.rmeta` file.