[llvm] afd9e35 - [LangRef] document override-stack-alignment module flag

[Nick Desaulniers via llvm-commits]

Author: Nick Desaulniers
Date: 2023-08-24T11:08:26-07:00
New Revision: afd9e356c8b5054003d11889e76cfdb0cd5d2ec7

URL: https://github.com/llvm/llvm-project/commit/afd9e356c8b5054003d11889e76cfdb0cd5d2ec7
DIFF: https://github.com/llvm/llvm-project/commit/afd9e356c8b5054003d11889e76cfdb0cd5d2ec7.diff

LOG: [LangRef] document override-stack-alignment module flag

This module flag was added in D103048.

Reviewed By: tejohnson

Differential Revision: https://reviews.llvm.org/D158524

Added: 
    

Modified: 
    llvm/docs/LangRef.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index 9aed930e1c81b2..f680c82cea0701 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -7829,6 +7829,20 @@ Some optimisations are only when the entire LTO unit is present in the current
 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 
diff erent 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
 ===============================