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
59 lines
1.4 KiB
ReStructuredText
59 lines
1.4 KiB
ReStructuredText
llvm-link - LLVM bitcode linker
|
|
===============================
|
|
|
|
.. program:: llvm-link
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
:program:`llvm-link` [*options*] *filename ...*
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
:program:`llvm-link` takes several LLVM bitcode files and links them together
|
|
into a single LLVM bitcode file. It writes the output file to standard output,
|
|
unless the :option:`-o` option is used to specify a filename.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
.. option:: -f
|
|
|
|
Enable binary output on terminals. Normally, :program:`llvm-link` will refuse
|
|
to write raw bitcode output if the output stream is a terminal. With this
|
|
option, :program:`llvm-link` will write raw bitcode regardless of the output
|
|
device.
|
|
|
|
.. option:: -o filename
|
|
|
|
Specify the output file name. If ``filename`` is "``-``", then
|
|
:program:`llvm-link` will write its output to standard output.
|
|
|
|
.. option:: -S
|
|
|
|
Write output in LLVM intermediate language (instead of bitcode).
|
|
|
|
.. option:: -d
|
|
|
|
If specified, :program:`llvm-link` prints a human-readable version of the
|
|
output bitcode file to standard error.
|
|
|
|
.. option:: -help
|
|
|
|
Print a summary of command line options.
|
|
|
|
.. option:: -v
|
|
|
|
Verbose mode. Print information about what :program:`llvm-link` is doing.
|
|
This typically includes a message for each bitcode file linked in and for each
|
|
library found.
|
|
|
|
EXIT STATUS
|
|
-----------
|
|
|
|
If :program:`llvm-link` succeeds, it will exit with 0. Otherwise, if an error
|
|
occurs, it will exit with a non-zero value.
|
|
|
|
|