2012-05-08 18:50:35 +02:00
|
|
|
llvm-stress - generate random .ll files
|
|
|
|
|
=======================================
|
|
|
|
|
|
[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-stress
|
|
|
|
|
|
2012-05-08 18:50:35 +02:00
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
|
|
|
|
|
2012-11-29 20:05:55 +01:00
|
|
|
:program:`llvm-stress` [-size=filesize] [-seed=initialseed] [-o=outfile]
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
2012-11-29 20:05:55 +01:00
|
|
|
The :program:`llvm-stress` tool is used to generate random ``.ll`` files that
|
|
|
|
|
can be used to test different components of LLVM.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
|
-------
|
|
|
|
|
|
2012-11-29 20:05:55 +01:00
|
|
|
.. option:: -o filename
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
|
Specify the output filename.
|
|
|
|
|
|
2012-11-29 20:05:55 +01:00
|
|
|
.. option:: -size size
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2012-11-29 20:05:55 +01:00
|
|
|
Specify the size of the generated ``.ll`` file.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2012-11-29 20:05:55 +01:00
|
|
|
.. option:: -seed seed
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
|
Specify the seed to be used for the randomly generated instructions.
|
|
|
|
|
|
|
|
|
|
EXIT STATUS
|
|
|
|
|
-----------
|
|
|
|
|
|
2012-11-29 20:05:55 +01:00
|
|
|
:program:`llvm-stress` returns 0.
|
