mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2025-04-14 13:40:10 +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
82 lines
2.4 KiB
ReStructuredText
82 lines
2.4 KiB
ReStructuredText
llvm-extract - extract a function from an LLVM module
|
|
=====================================================
|
|
|
|
.. program:: llvm-extract
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
:program:`llvm-extract` [*options*] **--func** *function-name* [*filename*]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
The :program:`llvm-extract` command takes the name of a function and extracts
|
|
it from the specified LLVM bitcode file. It is primarily used as a debugging
|
|
tool to reduce test cases from larger programs that are triggering a bug.
|
|
|
|
In addition to extracting the bitcode of the specified function,
|
|
:program:`llvm-extract` will also remove unreachable global variables,
|
|
prototypes, and unused types.
|
|
|
|
The :program:`llvm-extract` command reads its input from standard input if
|
|
filename is omitted or if filename is ``-``. The output is always written to
|
|
standard output, unless the **-o** option is specified (see below).
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
**-f**
|
|
|
|
Enable binary output on terminals. Normally, :program:`llvm-extract` will
|
|
refuse to write raw bitcode output if the output stream is a terminal. With
|
|
this option, :program:`llvm-extract` will write raw bitcode regardless of the
|
|
output device.
|
|
|
|
**--func** *function-name*
|
|
|
|
Extract the function named *function-name* from the LLVM bitcode. May be
|
|
specified multiple times to extract multiple functions at once.
|
|
|
|
**--rfunc** *function-regular-expr*
|
|
|
|
Extract the function(s) matching *function-regular-expr* from the LLVM bitcode.
|
|
All functions matching the regular expression will be extracted. May be
|
|
specified multiple times.
|
|
|
|
**--glob** *global-name*
|
|
|
|
Extract the global variable named *global-name* from the LLVM bitcode. May be
|
|
specified multiple times to extract multiple global variables at once.
|
|
|
|
**--rglob** *glob-regular-expr*
|
|
|
|
Extract the global variable(s) matching *global-regular-expr* from the LLVM
|
|
bitcode. All global variables matching the regular expression will be
|
|
extracted. May be specified multiple times.
|
|
|
|
**-help**
|
|
|
|
Print a summary of command line options.
|
|
|
|
**-o** *filename*
|
|
|
|
Specify the output filename. If filename is "-" (the default), then
|
|
:program:`llvm-extract` sends its output to standard output.
|
|
|
|
**-S**
|
|
|
|
Write output in LLVM intermediate language (instead of bitcode).
|
|
|
|
EXIT STATUS
|
|
-----------
|
|
|
|
If :program:`llvm-extract` succeeds, it will exit with 0. Otherwise, if an error
|
|
occurs, it will exit with a non-zero value.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
bugpoint
|
|
|