diff options
| author | Michael J. Spencer <bigcheesegs@gmail.com> | 2013-02-05 20:27:22 +0000 |
|---|---|---|
| committer | Michael J. Spencer <bigcheesegs@gmail.com> | 2013-02-05 20:27:22 +0000 |
| commit | dd3aa9eab2b40ea1573a5482472bbb89e6f1038d (patch) | |
| tree | faa04cd3474d8479c71875dadeda249842a2f133 /tools/llvm-readobj/llvm-readobj.cpp | |
| parent | 39b5f12dd68430c4794b1d24af0fd204c82bc12f (diff) | |
| download | llvm-dd3aa9eab2b40ea1573a5482472bbb89e6f1038d.tar.gz llvm-dd3aa9eab2b40ea1573a5482472bbb89e6f1038d.tar.bz2 llvm-dd3aa9eab2b40ea1573a5482472bbb89e6f1038d.tar.xz | |
[objdump,readobj] Document the purpose and goals of each tool.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@174439 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'tools/llvm-readobj/llvm-readobj.cpp')
| -rw-r--r-- | tools/llvm-readobj/llvm-readobj.cpp | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/tools/llvm-readobj/llvm-readobj.cpp b/tools/llvm-readobj/llvm-readobj.cpp index d22ecd1b04..2edb660cf9 100644 --- a/tools/llvm-readobj/llvm-readobj.cpp +++ b/tools/llvm-readobj/llvm-readobj.cpp @@ -7,12 +7,15 @@ // //===----------------------------------------------------------------------===// // -// This program is a utility that works like traditional Unix "readelf", -// except that it can handle any type of object file recognized by lib/Object. +// This is a tool similar to readelf, except it works on multiple object file +// formats. The main purpose of this tool is to provide detailed output suitable +// for FileCheck. // -// It makes use of the generic ObjectFile interface. +// Flags should be similar to readelf where supported, but the output format +// does not need to be identical. The point is to not make users learn yet +// another set of flags. // -// Caution: This utility is new, experimental, unsupported, and incomplete. +// Output should be specialized for each format where appropriate. // //===----------------------------------------------------------------------===// |