2019-06-08 00:03:02 +02:00
llvm-lipo - LLVM tool for manipulating universal binaries
=========================================================
[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-lipo
2019-06-08 00:03:02 +02:00
SYNOPSIS
--------
:program: `llvm-lipo` [*filenames...* ] [*options* ]
DESCRIPTION
-----------
:program: `llvm-lipo` can create universal binaries from Mach-O files, extract regular object files from universal binaries, and display architecture information about both universal and regular files.
COMMANDS
--------
:program: `llvm-lipo` supports the following mutually exclusive commands:
.. option :: -help, -h
2019-08-08 01:25:12 +02:00
Display usage information and exit.
2019-06-08 00:03:02 +02:00
.. option :: -version
2019-08-08 01:25:12 +02:00
Display the version of this program.
2019-06-08 00:03:02 +02:00
.. option :: -verify_arch <architecture 1> [<architecture 2> ...]
2019-08-08 01:25:12 +02:00
Take a single input file and verify the specified architectures are present in the file.
2019-06-08 00:03:02 +02:00
If so then exit with a status of 0 else exit with a status of 1.
2019-06-12 19:37:01 +02:00
.. option :: -archs
Take a single input file and display the architectures present in the file.
Each architecture is separated by a single whitespace.
Unknown architectures are displayed as unknown(CPUtype,CPUsubtype).
2019-08-08 01:25:12 +02:00
.. option :: -info
Take at least one input file and display the descriptions of each file.
The descriptions include the filename and architecture types separated by whitespace.
Universal binaries are grouped together first, followed by thin files.
Architectures in the fat file: <filename> are: <architectures>
Non-fat file: <filename> is architecture: <architecture>
.. option :: -thin
Take a single universal binary input file and the thin flag followed by an architecture type.
Require the output flag to be specified, and output a thin binary of the specified architecture.
.. option :: -create
Take at least one input file and require the output flag to be specified.
Output a universal binary combining the input files.
.. option :: -replace
Take a single universal binary input file and require the output flag to be specified.
The replace flag is followed by an architecture type, and a thin input file.
Output a universal binary with the specified architecture slice in the
universal binary input replaced with the contents of the thin input file.
.. option :: -segalign
Additional flag that can be specified with create and replace.
The segalign flag is followed by an architecture type, and an alignment.
The alignment is a hexadecimal number that is a power of 2.
Output a file in which the slice with the specified architecture has the specified alignment.
2019-06-08 00:03:02 +02:00
BUGS
----
To report bugs, please visit <http://llvm.org/bugs/>.
