[PATCH] D118284: [BOLT][docs] Add note regarding DWARF v5 support to README.md

[Maksim Panchenko via Phabricator via llvm-commits]

maksfb created this revision.
maksfb added reviewers: ayermolo, Amir, yota9.
Herald added a reviewer: rafauler.
maksfb requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D118284

Files:
  bolt/README.md


Index: bolt/README.md
===================================================================
--- bolt/README.md
+++ bolt/README.md
@@ -30,6 +30,14 @@
 explicitly disable it by adding `-fno-reorder-blocks-and-partition` flag if
 you are compiling with GCC8 or above.
 
+NOTE2: DWARF v5 is the new debugging format generated by the latest LLVM and GCC
+compilers. It offers several benefits over the previous DWARF v4. Currently, the
+support for v5 is a work in progress for BOLT. While you will be able to
+optimize binaries produced by the latest compilers, until the support is
+complete, you will not be able to update the debug info with
+`-update-debug-sections`. To temporarily work around the issue, we recommend
+compiling binaries with `-gdwarf-4` option that forces DWARF v4 output.
+
 PIE and .so support has been added recently. Please report bugs if you
 encounter any issues.
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D118284.403400.patch
Type: text/x-patch
Size: 889 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220126/e8f89e53/attachment.bin>