[PATCH] D158524: [LangRef] document override-stack-alignment module flag

[Nick Desaulniers via Phabricator via llvm-commits]

nickdesaulniers updated this revision to Diff 552409.
nickdesaulniers marked an inline comment as done.
nickdesaulniers added a comment.

- singular, add note about error


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D158524/new/

https://reviews.llvm.org/D158524

Files:
  llvm/docs/LangRef.rst


Index: llvm/docs/LangRef.rst
===================================================================
--- llvm/docs/LangRef.rst
+++ llvm/docs/LangRef.rst
@@ -7822,6 +7822,20 @@
 module. This is represented by the ``LTOPostLink`` module flags metadata, which
 will be created with a value of ``1`` when LTO linking occurs.
 
+Stack Alignment Metadata
+------------------------
+
+Changes the default stack alignment from the target ABI's implicit default
+stack alignment. Takes an i32 value in bytes. It is considered an error to link
+two modules together with different values for this metadata.
+
+For example:
+
+    !llvm.module.flags = !{!0}
+    !0 = !{i32 1, !"override-stack-alignment", i32 8}
+
+This will change the stack alignment to 8B.
+
 Embedded Objects Names Metadata
 ===============================
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D158524.552409.patch
Type: text/x-patch
Size: 815 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230822/5277cbbd/attachment.bin>