llvm-mirror/docs/CommandGuide/llvm-lipo.rst
James Henderson f75dcd7d67 [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 13:24:46 +00:00

42 lines
1.1 KiB
ReStructuredText

llvm-lipo - LLVM tool for manipulating universal binaries
=========================================================
.. program:: llvm-lipo
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
Display usage information and exit.
.. option:: -version
Display the version of this program.
.. option:: -verify_arch <architecture 1> [<architecture 2> ...]
Take a single input file and verify the specified architectures are present in the file.
If so then exit with a status of 0 else exit with a status of 1.
.. 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).
BUGS
----
To report bugs, please visit <http://llvm.org/bugs/>.