2015-07-18 02:49:26 +08:00
|
|
|
llvm-lib - LLVM lib.exe compatible library tool
|
|
|
|
|
===============================================
|
|
|
|
|
|
[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 21:24:46 +08:00
|
|
|
.. program:: llvm-lib
|
2015-07-18 02:49:26 +08:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
**llvm-lib** [/libpath:<path>] [/out:<output>] [/llvmlibthin]
|
|
|
|
|
[/ignore] [/machine] [/nologo] [files...]
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The **llvm-lib** command is intended to be a ``lib.exe`` compatible
|
|
|
|
|
tool. See https://msdn.microsoft.com/en-us/library/7ykb2k5f for the
|
|
|
|
|
general description.
|
|
|
|
|
|
|
|
|
|
**llvm-lib** has the following extensions:
|
|
|
|
|
|
|
|
|
|
* Bitcode files in symbol tables.
|
|
|
|
|
**llvm-lib** includes symbols from both bitcode files and regular
|
|
|
|
|
object files in the symbol table.
|
|
|
|
|
|
|
|
|
|
* Creating thin archives.
|
|
|
|
|
The /llvmlibthin option causes **llvm-lib** to create thin archive
|
|
|
|
|
that contain only the symbol table and the header for the various
|
|
|
|
|
members. These files are much smaller, but are not compatible with
|
|
|
|
|
link.exe (lld can handle them).
|
