mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-12-12 22:17:47 +00:00
[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
This commit is contained in:
parent
9b31bc723f
commit
da23aa20fe
@ -20,11 +20,8 @@ Basic Commands
|
||||
llc
|
||||
lli
|
||||
llvm-link
|
||||
llvm-ar
|
||||
llvm-lib
|
||||
llvm-lipo
|
||||
llvm-nm
|
||||
llvm-objdump
|
||||
llvm-config
|
||||
llvm-cxxmap
|
||||
llvm-diff
|
||||
@ -32,12 +29,29 @@ Basic Commands
|
||||
llvm-profdata
|
||||
llvm-stress
|
||||
llvm-symbolizer
|
||||
llvm-addr2line
|
||||
llvm-dwarfdump
|
||||
dsymutil
|
||||
llvm-mca
|
||||
llvm-readobj
|
||||
|
||||
GNU binutils replacements
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
llvm-addr2line
|
||||
llvm-ar
|
||||
llvm-cxxfilt
|
||||
llvm-nm
|
||||
llvm-objcopy
|
||||
llvm-objdump
|
||||
llvm-ranlib
|
||||
llvm-readelf
|
||||
llvm-size
|
||||
llvm-strings
|
||||
llvm-strip
|
||||
|
||||
Debugging Tools
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
|
10
docs/CommandGuide/llvm-cxxfilt.md
Normal file
10
docs/CommandGuide/llvm-cxxfilt.md
Normal file
@ -0,0 +1,10 @@
|
||||
# llvm-cxxfilt - a symbol demangler
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
**llvm-cxxfilt** [*options*]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
**llvm-cxxfilt** is symbol demangler that can be used as a replacement for the
|
||||
GNU **c++filt** tool.
|
16
docs/CommandGuide/llvm-objcopy.md
Normal file
16
docs/CommandGuide/llvm-objcopy.md
Normal file
@ -0,0 +1,16 @@
|
||||
# llvm-objcopy - object copying tool
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
**llvm-objcopy** [*options*]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
**llvm-objcopy** is a tool to copy and manipulate objects.
|
||||
|
||||
The tool is still in active development, but in most scenarios it works as a
|
||||
drop-in replacement for GNU's **objcopy**.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
[llvm-strip](llvm-strip.html)
|
17
docs/CommandGuide/llvm-ranlib.md
Normal file
17
docs/CommandGuide/llvm-ranlib.md
Normal file
@ -0,0 +1,17 @@
|
||||
# llvm-ranlib - generates an archive index
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
**llvm-ranlib** [*options*]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
**llvm-ranlib** is an alias for the [llvm-ar](llvm-ar.html) tool that generates
|
||||
an index for an archive. It can be used as a replacement for GNU's **ranlib**
|
||||
tool.
|
||||
|
||||
Running **llvm-ranlib** is equivalent to running **llvm-ar s**.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
Refer to [llvm-ar](llvm-ar.html) for additional information.
|
28
docs/CommandGuide/llvm-readelf.md
Normal file
28
docs/CommandGuide/llvm-readelf.md
Normal file
@ -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.
|
10
docs/CommandGuide/llvm-size.md
Normal file
10
docs/CommandGuide/llvm-size.md
Normal file
@ -0,0 +1,10 @@
|
||||
# llvm-size - print segment sizes
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
**llvm-size** [*options*]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
**llvm-size** is a tool that prints segment sizes in object files. The goal is
|
||||
to make it a drop-in replacement for GNU's **size**.
|
10
docs/CommandGuide/llvm-strings.md
Normal file
10
docs/CommandGuide/llvm-strings.md
Normal file
@ -0,0 +1,10 @@
|
||||
# llvm-strings - print strings
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
**llvm-strings** [*options*]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
**llvm-strings** is a tool that prints strings in object files. The goal is to
|
||||
make it a drop-in replacement for GNU's **size**.
|
16
docs/CommandGuide/llvm-strip.md
Normal file
16
docs/CommandGuide/llvm-strip.md
Normal file
@ -0,0 +1,16 @@
|
||||
# llvm-strip - object stripping tool
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
**llvm-strip** [*options*]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
**llvm-strip** is a tool to strip sections and symbols from object files.
|
||||
|
||||
The tool is still in active development, but in most scenarios it works as a
|
||||
drop-in replacement for GNU's **strip**.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
[llvm-objcopy](llvm-objcopy.html)
|
Loading…
Reference in New Issue
Block a user