mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2025-04-14 05:20:30 +00:00
f75dcd7d67
Sphinx allows for definitions of command-line options using `.. option <name>` and references to those options via `:option:<name>`. However, it looks like there is no scoping of these options by default, meaning that links can end up pointing to incorrect documents. See for example the llvm-mca document, which contains references to -o that, prior to this patch, pointed to a different document. What's worse is that these links appear to be non-deterministic in which one is picked (on my machine, some references end up pointing to opt, whereas on the live docs, they point to llvm-dwarfdump, for example). The fix is to add the .. program <name> tag. This essentially namespaces the options (definitions and references) to the named program, ensuring that the links are kept correct. Reviwed by: andreadb Differential Revision: https://reviews.llvm.org/D63873 llvm-svn: 364538
71 lines
1.3 KiB
ReStructuredText
71 lines
1.3 KiB
ReStructuredText
llvm-dis - LLVM disassembler
|
|
============================
|
|
|
|
.. program:: llvm-dis
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
|
|
**llvm-dis** [*options*] [*filename*]
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
|
|
The **llvm-dis** command is the LLVM disassembler. It takes an LLVM
|
|
bitcode file and converts it into human-readable LLVM assembly language.
|
|
|
|
If filename is omitted or specified as ``-``, **llvm-dis** reads its
|
|
input from standard input.
|
|
|
|
If the input is being read from standard input, then **llvm-dis**
|
|
will send its output to standard output by default. Otherwise, the
|
|
output will be written to a file named after the input file, with
|
|
a ``.ll`` suffix added (any existing ``.bc`` suffix will first be
|
|
removed). You can override the choice of output file using the
|
|
**-o** option.
|
|
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
|
|
|
|
**-f**
|
|
|
|
Enable binary output on terminals. Normally, **llvm-dis** will refuse to
|
|
write raw bitcode output if the output stream is a terminal. With this option,
|
|
**llvm-dis** will write raw bitcode regardless of the output device.
|
|
|
|
|
|
|
|
**-help**
|
|
|
|
Print a summary of command line options.
|
|
|
|
|
|
|
|
**-o** *filename*
|
|
|
|
Specify the output file name. If *filename* is -, then the output is sent
|
|
to standard output.
|
|
|
|
|
|
|
|
|
|
EXIT STATUS
|
|
-----------
|
|
|
|
|
|
If **llvm-dis** succeeds, it will exit with 0. Otherwise, if an error
|
|
occurs, it will exit with a non-zero value.
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
|
|
llvm-as|llvm-as
|