mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2025-04-13 04:52:50 +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
37 lines
656 B
ReStructuredText
37 lines
656 B
ReStructuredText
llvm-stress - generate random .ll files
|
|
=======================================
|
|
|
|
.. program:: llvm-stress
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
:program:`llvm-stress` [-size=filesize] [-seed=initialseed] [-o=outfile]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
The :program:`llvm-stress` tool is used to generate random ``.ll`` files that
|
|
can be used to test different components of LLVM.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
.. option:: -o filename
|
|
|
|
Specify the output filename.
|
|
|
|
.. option:: -size size
|
|
|
|
Specify the size of the generated ``.ll`` file.
|
|
|
|
.. option:: -seed seed
|
|
|
|
Specify the seed to be used for the randomly generated instructions.
|
|
|
|
EXIT STATUS
|
|
-----------
|
|
|
|
:program:`llvm-stress` returns 0.
|
|
|