summaryrefslogtreecommitdiffstats
path: root/llvm/docs/CommandGuide/llvm-readelf.md
diff options
context:
space:
mode:
authorJordan Rupprecht <rupprecht@google.com>2019-06-11 21:13:01 +0000
committerJordan Rupprecht <rupprecht@google.com>2019-06-11 21:13:01 +0000
commit4c3722aea81a20a5de9b01eb5f68320f975c6209 (patch)
tree7d0f965dd8cc7db91a906169aa238da5dcb555e3 /llvm/docs/CommandGuide/llvm-readelf.md
parent903d3db59347dcc808d76703105e3c9a9ce413f7 (diff)
downloadbcm5719-llvm-4c3722aea81a20a5de9b01eb5f68320f975c6209.tar.gz
bcm5719-llvm-4c3722aea81a20a5de9b01eb5f68320f975c6209.zip
[docs] Add "GNU binutils Replacements" section to command guide
Summary: This splits out a section in the command guide for llvm tools that can be used as replacements for GNU tools. For pages that didn't exist, I added stub pages that can be individually filled in by followup patches. Tested by running `ninja docs-llvm-html` and inspecting locally. Reviewers: jhenderson, MaskRay, grimar, alexshap Reviewed By: jhenderson, MaskRay, grimar Subscribers: smeenai, arphaman, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D63014 llvm-svn: 363100
Diffstat (limited to 'llvm/docs/CommandGuide/llvm-readelf.md')
-rw-r--r--llvm/docs/CommandGuide/llvm-readelf.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/llvm/docs/CommandGuide/llvm-readelf.md b/llvm/docs/CommandGuide/llvm-readelf.md
new file mode 100644
index 00000000000..a03844da1a2
--- /dev/null
+++ b/llvm/docs/CommandGuide/llvm-readelf.md
@@ -0,0 +1,28 @@
+# llvm-readelf - a drop-in replacement for readelf
+
+## SYNOPSIS
+
+**llvm-readelf** [*options*]
+
+## DESCRIPTION
+
+**llvm-readelf** is an alias for the [llvm-readobj](llvm-readobj.html) tool with
+a command-line interface and output style more closely resembling GNU
+**readelf**.
+
+Here are some of those differences:
+
+* Uses `--elf-output-style=GNU` by default.
+
+* Allows single-letter grouped flags (e.g. `llvm-readelf -SW` is the same as
+ `llvm-readelf -S -W`).
+
+* Allows use of `-s` as an alias for `--symbols` (versus `--section-headers` in
+ **llvm-readobj**) for GNU **readelf** compatibility.
+
+* Prevents use of `-sr`, `-sd`, `-st` and `-dt` **llvm-readobj** aliases, to
+ avoid conflicting with standard GNU **readelf** grouped flags.
+
+## SEE ALSO
+
+Refer to [llvm-readobj](llvm-readobj.html) for additional information.
OpenPOWER on IntegriCloud