docs: this llvm feature only supports the ELF object format

rust-lang · Sep 26, 2018 · 234e7c4 · 234e7c4
1 parent 5e686b2
commit 234e7c4
Showing 1 changed file with 4 additions and 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
@@ -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:
 
 ```