[PATCH] D24706: [ELF] - Partial support of --gdb-index command line option (Part 1).

[Adrian Prantl via llvm-commits]

aprantl added a comment.

Some minor nitpicks.
Eric, David, can you look at how this fits into the big picture for split debug info. support on ELF platforms?


================
Comment at: ELF/SplitDebugInfo.cpp:10
@@ +9,3 @@
+//
+// File contains classes for implementation of --gdb-index command line option.
+//
----------------
Any way this could be doxygen-ified?

================
Comment at: ELF/SplitDebugInfo.cpp:17
@@ +16,3 @@
+//
+// Split debug information feature tries to solve the problems caused by huge
+// amounts of debug information in large applications.
----------------
Since LLVM already supports split debug info I don't think there is a need to re-explain this here — But there might be a better place to document this: Maybe it makes sense to move the general introuction to SourceLevelDebugging.rst?

================
Comment at: ELF/SplitDebugInfo.cpp:28
@@ +27,3 @@
+// needs them. More specific information can be found at
+// https://gcc.gnu.org/wiki/DebugFission.
+//
----------------
Maybe better link to the DWARF 5 specification?
http://dwarfstd.org/Issues.php?type=closed4

================
Comment at: ELF/SplitDebugInfo.cpp:59
@@ +58,3 @@
+//
+// For costructing the .gdb_index section following steps should be performed:
+// 1) For file header nothing special should be done. It contains the offsets to
----------------
constructing

================
Comment at: ELF/SplitDebugInfo.h:58
@@ +57,3 @@
+// separate object file section called ".debug_abbrev".
+// Defines the abbreviation codes used by the skeleton .debug_info section.
+template <class ELFT> class DwarfAbbrevTable {
----------------
Please convert all of these top-level class comments to Doxygen comments by using `///`


https://reviews.llvm.org/D24706