mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-29 10:46:06 +00:00
b4ba5c7984
D147710 introduced a new annotation-count subcommand to llvm-remarkutil and added in documentation. However, the reference added under the subcommands list never actually pointed to anything. This patch adds a marker for the reference to point to so that the link works and the sphinx build finishes without any errors.
99 lines
2.3 KiB
ReStructuredText
99 lines
2.3 KiB
ReStructuredText
llvm-remarkutil - Remark utility
|
|
================================
|
|
|
|
.. program:: llvm-remarkutil
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
:program:`llvm-remarkutil` [*subcommmand*] [*options*]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
Utility for displaying information from, and converting between different
|
|
`remark <https://llvm.org/docs/Remarks.html>`_ formats.
|
|
|
|
Subcommands
|
|
-----------
|
|
|
|
* :ref:`bitstream2yaml_subcommand` - Reserialize bitstream remarks to YAML.
|
|
* :ref:`yaml2bitstream_subcommand` - Reserialize YAML remarks to bitstream.
|
|
* :ref:`instruction-count_subcommand` - Output function instruction counts.
|
|
* :ref:`annotation-count_subcommand` - Output remark type count from annotation remarks.
|
|
|
|
.. _bitstream2yaml_subcommand:
|
|
|
|
bitstream2yaml
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. program:: llvm-remarkutil bitstream2yaml
|
|
|
|
USAGE: :program:`llvm-remarkutil` bitstream2yaml <input file> -o <output file>
|
|
|
|
Summary
|
|
^^^^^^^
|
|
|
|
Takes a bitstream remark file as input, and reserializes that file as YAML.
|
|
|
|
.. _yaml2bitstream_subcommand:
|
|
|
|
yaml2bitstream
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. program:: llvm-remarkutil yaml2bitstream
|
|
|
|
USAGE: :program:`llvm-remarkutil` yaml2bitstream <input file> -o <output file>
|
|
|
|
Summary
|
|
^^^^^^^
|
|
|
|
Takes a YAML remark file as input, and reserializes that file in the bitstream
|
|
format.
|
|
|
|
.. _instruction-count_subcommand:
|
|
|
|
instruction-count
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. program:: llvm-remarkutil instruction-count
|
|
|
|
USAGE: :program:`llvm-remarkutil` instruction-count <input file> --parser=<bitstream|yaml> -o <output file>
|
|
|
|
Summary
|
|
^^^^^^^
|
|
|
|
Outputs instruction count remarks for every function. Instruction count remarks
|
|
encode the number of instructions in a function at assembly printing time.
|
|
|
|
Instruction count remarks require asm-printer remarks.
|
|
|
|
CSV format is as follows:
|
|
|
|
::
|
|
Function,InstructionCount
|
|
foo,123
|
|
|
|
.. _annotation-count_subcommand:
|
|
|
|
annotation-count
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. program:: llvm-remarkutil annotation-count
|
|
|
|
USAGE: :program:`llvm-remarkutil` annotation-count <input file> --parser=<bitstream|yaml> --annotation-type=<type> -o <output file>
|
|
|
|
Summary
|
|
^^^^^^^
|
|
|
|
Outputs a count for annotation-type `<type>` remark for every function. The count expresses
|
|
the number of remark checks inserted at the function.
|
|
|
|
Annotation count remarks require AnnotationRemarksPass remarks.
|
|
|
|
CSV format is as follows:
|
|
|
|
::
|
|
Function,Count
|
|
foo,123
|