Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[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...
commit dd3aa9eab2b40ea1573a5482472bbb89e6f1038d 1 parent 39b5f12
Michael Spencer Bigcheese authored
3  tools/llvm-objdump/llvm-objdump.cpp
@@ -11,6 +11,9 @@
11 11 // dumps out a plethora of information about an object file depending on the
12 12 // flags.
13 13 //
  14 +// The flags and output of this program should be near identical to those of
  15 +// binutils objdump.
  16 +//
14 17 //===----------------------------------------------------------------------===//
15 18
16 19 #include "llvm-objdump.h"
11 tools/llvm-readobj/llvm-readobj.cpp
@@ -7,12 +7,15 @@
7 7 //
8 8 //===----------------------------------------------------------------------===//
9 9 //
10   -// This program is a utility that works like traditional Unix "readelf",
11   -// except that it can handle any type of object file recognized by lib/Object.
  10 +// This is a tool similar to readelf, except it works on multiple object file
  11 +// formats. The main purpose of this tool is to provide detailed output suitable
  12 +// for FileCheck.
12 13 //
13   -// It makes use of the generic ObjectFile interface.
  14 +// Flags should be similar to readelf where supported, but the output format
  15 +// does not need to be identical. The point is to not make users learn yet
  16 +// another set of flags.
14 17 //
15   -// Caution: This utility is new, experimental, unsupported, and incomplete.
  18 +// Output should be specialized for each format where appropriate.
16 19 //
17 20 //===----------------------------------------------------------------------===//
18 21

0 comments on commit dd3aa9e

Please sign in to comment.
Something went wrong with that request. Please try again.