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

George Rimar via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Thu Dec 15 04:18:39 PST 2016

grimar added a comment.


Comment at: ELF/GdbIndex.cpp:157
+// slot when handling a hash collision is specified in .gdb_index section format
+// (https://sourceware.org/gdb/onlinedocs/gdb/Index-Section-Format.html)
+GdbSymbol **GdbHashTab::findSlot(uint32_t Hash, size_t Offset) {
aprantl wrote:
> Coding guidelines want this to be a doxygen comment on the declaration in the header. 
> Is it possible to paraphrase the contents of the links in the comment? We don't usually put links into comments.
In LLD we often use the links in comments. Though in that case code itself just implements the formulas described in documentation. I replaced the link with short sentence about how it works in general. 
And as I mentioned earlier, we do not use oxygen style comments in that lld folder yet, so that also was not changed.

Comment at: ELF/SyntheticSections.cpp:1416
+// Iterative hash function for symbol's name is described at
+// https://sourceware.org/gdb/onlinedocs/gdb/Index-Section-Format.html
+static uint32_t hash(StringRef Str) {
aprantl wrote:
> same here.
I removed the link and added a short comment. We still have link in the file header, this comment refers to it.



More information about the llvm-commits mailing list