Skip to content

Commit af9eac8

Browse files
author
Kevin Frei
committed
Added usage comments
1 parent 389ff8a commit af9eac8

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

llvm/include/llvm/DebugInfo/DWARF/DWARFVerifier.h

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,14 @@ class DWARFVerifier {
101101
bool IsMachOObject;
102102
using ReferenceMap = std::map<uint64_t, std::set<uint64_t>>;
103103

104-
raw_ostream &aggregate(const char *);
104+
// For errors that have sensible names as the first (or only) string
105+
// you can just use aggregate() << "DIE looks stupid: " << details...
106+
// and it will get aggregated as "DIE looks stupid".
105107
ErrorAggregator &aggregate();
108+
// For errors that have details before good 'categories', you'll need
109+
// to provide the aggregated name, like this:
110+
// aggregate("CU index is busted") << "CU index [" << n << "] is busted"
111+
raw_ostream &aggregate(const char *);
106112
raw_ostream &error() const;
107113
raw_ostream &warn() const;
108114
raw_ostream &note() const;

0 commit comments

Comments
 (0)