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.6 KiB
ReStructuredText
59 lines
1.6 KiB
ReStructuredText
llvm-as - LLVM assembler
|
|
========================
|
|
|
|
.. program:: llvm-as
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
**llvm-as** [*options*] [*filename*]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
**llvm-as** is the LLVM assembler. It reads a file containing human-readable
|
|
LLVM assembly language, translates it to LLVM bitcode, and writes the result
|
|
into a file or to standard output.
|
|
|
|
If *filename* is omitted or is ``-``, then **llvm-as** reads its input from
|
|
standard input.
|
|
|
|
If an output file is not specified with the **-o** option, then
|
|
**llvm-as** sends its output to a file or standard output by following
|
|
these rules:
|
|
|
|
* If the input is standard input, then the output is standard output.
|
|
|
|
* If the input is a file that ends with ``.ll``, then the output file is of the
|
|
same name, except that the suffix is changed to ``.bc``.
|
|
|
|
* If the input is a file that does not end with the ``.ll`` suffix, then the
|
|
output file has the same name as the input file, except that the ``.bc``
|
|
suffix is appended.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
**-f**
|
|
Enable binary output on terminals. Normally, **llvm-as** will refuse to
|
|
write raw bitcode output if the output stream is a terminal. With this option,
|
|
**llvm-as** will write raw bitcode regardless of the output device.
|
|
|
|
**-help**
|
|
Print a summary of command line options.
|
|
|
|
**-o** *filename*
|
|
Specify the output file name. If *filename* is ``-``, then **llvm-as**
|
|
sends its output to standard output.
|
|
|
|
EXIT STATUS
|
|
-----------
|
|
|
|
If **llvm-as** succeeds, it will exit with 0. Otherwise, if an error occurs, it
|
|
will exit with a non-zero value.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
llvm-dis|llvm-dis, gccas|gccas
|