llvm.org GIT mirror llvm / 69f0756
[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 Jordan Rupprecht a month ago
8 changed file(s) with 125 addition(s) and 4 deletion(s). Raw diff Collapse all Expand all
1919 llc
2020 lli
2121 llvm-link
22 llvm-ar
2322 llvm-lib
2423 llvm-lipo
25 llvm-nm
26 llvm-objdump
2724 llvm-config
2825 llvm-cxxmap
2926 llvm-diff
3128 llvm-profdata
3229 llvm-stress
3330 llvm-symbolizer
34 llvm-addr2line
3531 llvm-dwarfdump
3632 dsymutil
3733 llvm-mca
3834 llvm-readobj
35
36 GNU binutils replacements
37 ~~~~~~~~~~~~~~~~~~~~~~~~~
38
39 .. toctree::
40 :maxdepth: 1
41
42 llvm-addr2line
43 llvm-ar
44 llvm-cxxfilt
45 llvm-nm
46 llvm-objcopy
47 llvm-objdump
48 llvm-ranlib
49 llvm-readelf
50 llvm-size
51 llvm-strings
52 llvm-strip
3953
4054 Debugging Tools
4155 ~~~~~~~~~~~~~~~
0 # llvm-cxxfilt - a symbol demangler
1
2 ## SYNOPSIS
3
4 **llvm-cxxfilt** [*options*]
5
6 ## DESCRIPTION
7
8 **llvm-cxxfilt** is symbol demangler that can be used as a replacement for the
9 GNU **c++filt** tool.
0 # llvm-objcopy - object copying tool
1
2 ## SYNOPSIS
3
4 **llvm-objcopy** [*options*]
5
6 ## DESCRIPTION
7
8 **llvm-objcopy** is a tool to copy and manipulate objects.
9
10 The tool is still in active development, but in most scenarios it works as a
11 drop-in replacement for GNU's **objcopy**.
12
13 ## SEE ALSO
14
15 [llvm-strip](llvm-strip.html)
0 # llvm-ranlib - generates an archive index
1
2 ## SYNOPSIS
3
4 **llvm-ranlib** [*options*]
5
6 ## DESCRIPTION
7
8 **llvm-ranlib** is an alias for the [llvm-ar](llvm-ar.html) tool that generates
9 an index for an archive. It can be used as a replacement for GNU's **ranlib**
10 tool.
11
12 Running **llvm-ranlib** is equivalent to running **llvm-ar s**.
13
14 ## SEE ALSO
15
16 Refer to [llvm-ar](llvm-ar.html) for additional information.
0 # llvm-readelf - a drop-in replacement for readelf
1
2 ## SYNOPSIS
3
4 **llvm-readelf** [*options*]
5
6 ## DESCRIPTION
7
8 **llvm-readelf** is an alias for the [llvm-readobj](llvm-readobj.html) tool with
9 a command-line interface and output style more closely resembling GNU
10 **readelf**.
11
12 Here are some of those differences:
13
14 * Uses `--elf-output-style=GNU` by default.
15
16 * Allows single-letter grouped flags (e.g. `llvm-readelf -SW` is the same as
17 `llvm-readelf -S -W`).
18
19 * Allows use of `-s` as an alias for `--symbols` (versus `--section-headers` in
20 **llvm-readobj**) for GNU **readelf** compatibility.
21
22 * Prevents use of `-sr`, `-sd`, `-st` and `-dt` **llvm-readobj** aliases, to
23 avoid conflicting with standard GNU **readelf** grouped flags.
24
25 ## SEE ALSO
26
27 Refer to [llvm-readobj](llvm-readobj.html) for additional information.
0 # llvm-size - print segment sizes
1
2 ## SYNOPSIS
3
4 **llvm-size** [*options*]
5
6 ## DESCRIPTION
7
8 **llvm-size** is a tool that prints segment sizes in object files. The goal is
9 to make it a drop-in replacement for GNU's **size**.
0 # llvm-strings - print strings
1
2 ## SYNOPSIS
3
4 **llvm-strings** [*options*]
5
6 ## DESCRIPTION
7
8 **llvm-strings** is a tool that prints strings in object files. The goal is to
9 make it a drop-in replacement for GNU's **size**.
0 # llvm-strip - object stripping tool
1
2 ## SYNOPSIS
3
4 **llvm-strip** [*options*]
5
6 ## DESCRIPTION
7
8 **llvm-strip** is a tool to strip sections and symbols from object files.
9
10 The tool is still in active development, but in most scenarios it works as a
11 drop-in replacement for GNU's **strip**.
12
13 ## SEE ALSO
14
15 [llvm-objcopy](llvm-objcopy.html)