summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRui Ueyama <ruiu@google.com>2016-09-29 01:26:48 +0000
committerRui Ueyama <ruiu@google.com>2016-09-29 01:26:48 +0000
commited1414b83c056616d453154742e3e451364b86aa (patch)
tree106448618002ef2466df80bfd8b8c4984e8d5d3d
parent615c5ae7aed841c73ab4c737a1e5b031bbb06b3c (diff)
downloadbcm5719-llvm-ed1414b83c056616d453154742e3e451364b86aa.tar.gz
bcm5719-llvm-ed1414b83c056616d453154742e3e451364b86aa.zip
Add comments.
llvm-svn: 282664
-rw-r--r--lld/ELF/Error.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/lld/ELF/Error.h b/lld/ELF/Error.h
index 34e63c6dda7..17dffaa84ea 100644
--- a/lld/ELF/Error.h
+++ b/lld/ELF/Error.h
@@ -6,6 +6,20 @@
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
+//
+// In LLD, we have three levels of errors: fatal, error or warn.
+//
+// Fatal makes the program exit immediately with an error message.
+// You shouldn't use it except for reporting a corrupted input file.
+//
+// Error prints out an error message and set a global variable HasError
+// to true to record the fact that we met an error condition. It does
+// not exit, so it is safe for a lld-as-a-library use case. It is generally
+// useful because it can report more than one errors in a single run.
+//
+// Warn doesn't do anything but printing out a given message.
+//
+//===----------------------------------------------------------------------===//
#ifndef LLD_ELF_ERROR_H
#define LLD_ELF_ERROR_H
OpenPOWER on IntegriCloud