[clang][docs] Clarify the semantics of -fexceptions
authorAlex Bradbury <asb@igalia.com>
Tue, 14 Mar 2023 19:52:32 +0000 (19:52 +0000)
committerAlex Bradbury <asb@igalia.com>
Tue, 14 Mar 2023 19:52:32 +0000 (19:52 +0000)
As noted in <https://github.com/llvm/llvm-project/issues/61216>, the
documentation for -fexceptions appears to imply that unwind information
is always generated, which isn't the case.

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

clang/docs/CommandGuide/clang.rst

index 7fae1b5cec53c93f9fd0f2853f91a2eae4658444..e076818697eb16c48bdb4105c94c452bc30dbe83 100644 (file)
@@ -473,8 +473,10 @@ Code Generation Options
 
 .. option:: -fexceptions
 
-  Enable generation of unwind information. This allows exceptions to be thrown
-  through Clang compiled stack frames.  This is on by default in x86-64.
+  Allow exceptions to be thrown through Clang compiled stack frames (on many
+  targets, this will enable unwind information for functions that might have
+  an exception thrown through them). For most targets, this is enabled by
+  default for C++.
 
 .. option:: -ftrapv