about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJorge Aparicio <jorge@japaric.io>2018-09-26 15:25:57 +0200
committerJorge Aparicio <jorge@japaric.io>2018-09-26 15:25:57 +0200
commit234e7c4d2efe249f1c38e23cf12ae84e65ee7e08 (patch)
tree2eae94456a89636072d3d6ae65168befecd1d143
parent5e686b210477de8679820d063e1736857e55d923 (diff)
downloadrust-234e7c4d2efe249f1c38e23cf12ae84e65ee7e08.tar.gz
rust-234e7c4d2efe249f1c38e23cf12ae84e65ee7e08.zip
docs: this llvm feature only supports the ELF object format
-rw-r--r--src/doc/unstable-book/src/compiler-flags/emit-stack-sizes.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/doc/unstable-book/src/compiler-flags/emit-stack-sizes.md b/src/doc/unstable-book/src/compiler-flags/emit-stack-sizes.md
index b5456f9ba39..47f45a0b91f 100644
--- a/src/doc/unstable-book/src/compiler-flags/emit-stack-sizes.md
+++ b/src/doc/unstable-book/src/compiler-flags/emit-stack-sizes.md
@@ -8,6 +8,10 @@ The tracking issue for this feature is: [#54192]
 
 The rustc flag `-Z emit-stack-sizes` makes LLVM emit stack size metadata.
 
+> **NOTE**: This LLVM feature only supports the ELF object format as of LLVM
+> 8.0. Using this flag with targets that use other object formats (e.g. macOS
+> and Windows) will result in it being ignored.
+
 Consider this crate:
 
 ```