Author: Michael Buch
Date: 2025-09-16T10:51:42+01:00
New Revision: fbb587c65653395dc97a360e0cd0d1cf9ed0e875

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

LOG: [clang][docs] Fix formatting of structor_decl_linkage_names DocBrief

The backticks weren't highlighting correctly.

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 54cc1e986b601..33019cd941498 100644
--- a/clang/include/clang/Driver/Options.td
+++ b/clang/include/clang/Driver/Options.td
@@ -4802,7 +4802,7 @@ defm structor_decl_linkage_names
                           "declarations in DWARF."
                           "Implies -g.">,
                   BothFlags<[], [ClangOption, CLOption, CC1Option]>>,
-                  DocBrief<[{On some ABIs (e.g., Itanium), constructors and 
destructors may have multiple variants. Historically, when generating DWARF, 
Clang did not attach ``DW_AT_linkage_name``s to structor DIEs because there 
were multiple possible manglings (depending on the structor variant) that could 
be used. With ``-gstructor-decl-linkage-names``, for ABIs with structor 
variants, we attach a "unified" mangled name to structor declarations DIEs 
which debuggers can use to look up all the definitions for a structor 
declaration. E.g., a "unified" mangled name ``_ZN3FooC4Ev`` may have multiple 
definitions associated with it such as ``_ZN3FooC1Ev`` and ``_ZN3FooC2Ev``.
+                  DocBrief<[{On some ABIs (e.g., Itanium), constructors and 
destructors may have multiple variants. Historically, when generating DWARF, 
Clang did not attach ``DW_AT_linkage_name`` to structor DIEs because there were 
multiple possible manglings (depending on the structor variant) that could be 
used. With ``-gstructor-decl-linkage-names``, for ABIs with structor variants, 
we attach a "unified" mangled name to structor declarations DIEs which 
debuggers can use to look up all the definitions for a structor declaration. 
E.g., a "unified" mangled name ``_ZN3FooC4Ev`` may have multiple definitions 
associated with it such as ``_ZN3FooC1Ev`` and ``_ZN3FooC2Ev``.
 
 Enabling this flag results in a better interactive debugging experience (both 
GDB and LLDB have support for understanding these "unified" linkage names). 
However, it comes with a significant increase in debug-info size (particularly 
the `.debug_str` section). As an escape hatch, users can disable this feature 
using ``-gno-structor-decl-linkage-names``.}]>;
 defm key_instructions : BoolGOption<"key-instructions",


        
_______________________________________________
cfe-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to