Permalink
Browse files

[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
  • Loading branch information...
1 parent 39b5f12 commit dd3aa9eab2b40ea1573a5482472bbb89e6f1038d @Bigcheese Bigcheese committed Feb 5, 2013
Showing with 10 additions and 4 deletions.
  1. +3 −0 tools/llvm-objdump/llvm-objdump.cpp
  2. +7 −4 tools/llvm-readobj/llvm-readobj.cpp
View
3 tools/llvm-objdump/llvm-objdump.cpp
@@ -11,6 +11,9 @@
// dumps out a plethora of information about an object file depending on the
// flags.
//
+// The flags and output of this program should be near identical to those of
+// binutils objdump.
+//
//===----------------------------------------------------------------------===//
#include "llvm-objdump.h"
View
11 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.
//
//===----------------------------------------------------------------------===//

0 comments on commit dd3aa9e

Please sign in to comment.