[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
This commit is contained in:
Michael J. Spencer
2013-02-05 20:27:22 +00:00
parent 39b5f12dd6
commit dd3aa9eab2
2 changed files with 10 additions and 4 deletions

View File

@ -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.
//
//===----------------------------------------------------------------------===//