[clang] 5f883cd - [docs] Document -fomit-frame-pointer

[Fangrui Song via cfe-commits]

Author: Fangrui Song
Date: 2023-03-23T10:19:10-07:00
New Revision: 5f883cdbfbe216ec184194114676075f3633e08b

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

LOG: [docs] Document -fomit-frame-pointer

Close #61322

Reviewed By: vitalybuka

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

Added: 
    

Modified: 
    clang/include/clang/Driver/Options.td

Removed: 
    


################################################################################
diff  --git a/clang/include/clang/Driver/Options.td b/clang/include/clang/Driver/Options.td
index b50dfd6f35510..821e86c0260f3 100644
--- a/clang/include/clang/Driver/Options.td
+++ b/clang/include/clang/Driver/Options.td
@@ -2638,7 +2638,11 @@ defm objc_avoid_heapify_local_blocks : BoolFOption<"objc-avoid-heapify-local-blo
   NegFlag<SetFalse, [], "Don't try">,
   BothFlags<[CC1Option, NoDriverOption], " to avoid heapifying local blocks">>;
 
-def fomit_frame_pointer : Flag<["-"], "fomit-frame-pointer">, Group<f_Group>;
+def fomit_frame_pointer : Flag<["-"], "fomit-frame-pointer">, Group<f_Group>,
+  HelpText<"Omit the frame pointer from functions that don't need it. "
+  "Some stack unwinding cases, such as profilers and sanitizers, may prefer specifying -fno-omit-frame-pointer. "
+  "On many targets, -O1 and higher omit the frame pointer by default. "
+  "-m[no-]omit-leaf-frame-pointer takes precedence for leaf functions">;
 def fopenmp : Flag<["-"], "fopenmp">, Group<f_Group>, Flags<[CC1Option, NoArgumentUnused, FlangOption, FC1Option]>,
   HelpText<"Parse OpenMP pragmas and generate parallel code.">;
 def fno_openmp : Flag<["-"], "fno-openmp">, Group<f_Group>, Flags<[NoArgumentUnused]>;