Skip to content
This repository was archived by the owner on Mar 28, 2020. It is now read-only.

Commit 69f0756

Browse files
committed
[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 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@363100 91177308-0d34-0410-b5e6-96231b3b80d8
1 parent dae5d38 commit 69f0756

File tree

8 files changed

+125
-4
lines changed

8 files changed

+125
-4
lines changed

docs/CommandGuide/index.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,38 @@ Basic Commands
2020
llc
2121
lli
2222
llvm-link
23-
llvm-ar
2423
llvm-lib
2524
llvm-lipo
26-
llvm-nm
27-
llvm-objdump
2825
llvm-config
2926
llvm-cxxmap
3027
llvm-diff
3128
llvm-cov
3229
llvm-profdata
3330
llvm-stress
3431
llvm-symbolizer
35-
llvm-addr2line
3632
llvm-dwarfdump
3733
dsymutil
3834
llvm-mca
3935
llvm-readobj
4036

37+
GNU binutils replacements
38+
~~~~~~~~~~~~~~~~~~~~~~~~~
39+
40+
.. toctree::
41+
:maxdepth: 1
42+
43+
llvm-addr2line
44+
llvm-ar
45+
llvm-cxxfilt
46+
llvm-nm
47+
llvm-objcopy
48+
llvm-objdump
49+
llvm-ranlib
50+
llvm-readelf
51+
llvm-size
52+
llvm-strings
53+
llvm-strip
54+
4155
Debugging Tools
4256
~~~~~~~~~~~~~~~
4357

docs/CommandGuide/llvm-cxxfilt.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# llvm-cxxfilt - a symbol demangler
2+
3+
## SYNOPSIS
4+
5+
**llvm-cxxfilt** [*options*]
6+
7+
## DESCRIPTION
8+
9+
**llvm-cxxfilt** is symbol demangler that can be used as a replacement for the
10+
GNU **c++filt** tool.

docs/CommandGuide/llvm-objcopy.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# llvm-objcopy - object copying tool
2+
3+
## SYNOPSIS
4+
5+
**llvm-objcopy** [*options*]
6+
7+
## DESCRIPTION
8+
9+
**llvm-objcopy** is a tool to copy and manipulate objects.
10+
11+
The tool is still in active development, but in most scenarios it works as a
12+
drop-in replacement for GNU's **objcopy**.
13+
14+
## SEE ALSO
15+
16+
[llvm-strip](llvm-strip.html)

docs/CommandGuide/llvm-ranlib.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# llvm-ranlib - generates an archive index
2+
3+
## SYNOPSIS
4+
5+
**llvm-ranlib** [*options*]
6+
7+
## DESCRIPTION
8+
9+
**llvm-ranlib** is an alias for the [llvm-ar](llvm-ar.html) tool that generates
10+
an index for an archive. It can be used as a replacement for GNU's **ranlib**
11+
tool.
12+
13+
Running **llvm-ranlib** is equivalent to running **llvm-ar s**.
14+
15+
## SEE ALSO
16+
17+
Refer to [llvm-ar](llvm-ar.html) for additional information.

docs/CommandGuide/llvm-readelf.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# llvm-readelf - a drop-in replacement for readelf
2+
3+
## SYNOPSIS
4+
5+
**llvm-readelf** [*options*]
6+
7+
## DESCRIPTION
8+
9+
**llvm-readelf** is an alias for the [llvm-readobj](llvm-readobj.html) tool with
10+
a command-line interface and output style more closely resembling GNU
11+
**readelf**.
12+
13+
Here are some of those differences:
14+
15+
* Uses `--elf-output-style=GNU` by default.
16+
17+
* Allows single-letter grouped flags (e.g. `llvm-readelf -SW` is the same as
18+
`llvm-readelf -S -W`).
19+
20+
* Allows use of `-s` as an alias for `--symbols` (versus `--section-headers` in
21+
**llvm-readobj**) for GNU **readelf** compatibility.
22+
23+
* Prevents use of `-sr`, `-sd`, `-st` and `-dt` **llvm-readobj** aliases, to
24+
avoid conflicting with standard GNU **readelf** grouped flags.
25+
26+
## SEE ALSO
27+
28+
Refer to [llvm-readobj](llvm-readobj.html) for additional information.

docs/CommandGuide/llvm-size.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# llvm-size - print segment sizes
2+
3+
## SYNOPSIS
4+
5+
**llvm-size** [*options*]
6+
7+
## DESCRIPTION
8+
9+
**llvm-size** is a tool that prints segment sizes in object files. The goal is
10+
to make it a drop-in replacement for GNU's **size**.

docs/CommandGuide/llvm-strings.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# llvm-strings - print strings
2+
3+
## SYNOPSIS
4+
5+
**llvm-strings** [*options*]
6+
7+
## DESCRIPTION
8+
9+
**llvm-strings** is a tool that prints strings in object files. The goal is to
10+
make it a drop-in replacement for GNU's **size**.

docs/CommandGuide/llvm-strip.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# llvm-strip - object stripping tool
2+
3+
## SYNOPSIS
4+
5+
**llvm-strip** [*options*]
6+
7+
## DESCRIPTION
8+
9+
**llvm-strip** is a tool to strip sections and symbols from object files.
10+
11+
The tool is still in active development, but in most scenarios it works as a
12+
drop-in replacement for GNU's **strip**.
13+
14+
## SEE ALSO
15+
16+
[llvm-objcopy](llvm-objcopy.html)

0 commit comments

Comments
 (0)