2013-03-19 17:04:19 +01:00
|
|
|
llvm-link - LLVM bitcode linker
|
|
|
|
|
===============================
|
2012-05-08 18:50:35 +02:00
|
|
|
|
[docs][tools] Add missing "program" tags to rst files
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
2019-06-27 15:24:46 +02:00
|
|
|
.. program:: llvm-link
|
|
|
|
|
|
2012-05-08 18:50:35 +02:00
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
|
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
:program:`llvm-link` [*options*] *filename ...*
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
: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.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
|
-------
|
|
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
.. option:: -f
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
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.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
.. option:: -o filename
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
Specify the output file name. If ``filename`` is "``-``", then
|
|
|
|
|
:program:`llvm-link` will write its output to standard output.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
.. option:: -S
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
|
Write output in LLVM intermediate language (instead of bitcode).
|
|
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
.. option:: -d
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2013-03-19 17:04:19 +01:00
|
|
|
If specified, :program:`llvm-link` prints a human-readable version of the
|
|
|
|
|
output bitcode file to standard error.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
.. option:: -help
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
|
Print a summary of command line options.
|
|
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
.. option:: -v
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
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
|
2012-05-08 18:50:35 +02:00
|
|
|
library found.
|
|
|
|
|
|
|
|
|
|
EXIT STATUS
|
|
|
|
|
-----------
|
|
|
|
|
|
2012-11-29 20:14:35 +01:00
|
|
|
If :program:`llvm-link` succeeds, it will exit with 0. Otherwise, if an error
|
2012-05-08 18:50:35 +02:00
|
|
|
occurs, it will exit with a non-zero value.
|
