mirrors/llvm-project
0
0
Fork 0
mirror of https://github.com/llvm/llvm-project.git synced 2025-05-04 23:06:05 +00:00
Code Issues Projects Releases Wiki Activity
llvm-project/llvm/docs/CommandGuide/llvm-remarkutil.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

111 lines
2.6 KiB
ReStructuredText
Raw Normal View History

Add missing description to llvm-remarkutil doc header Doc builder caught this: ``` File ".../llvm/src/llvm/docs/conf.py", line 271, in process_rst name,description = title.split(' - ', 1) ValueError: not enough values to unpack (expected 2, got 1) ```
2022-09-12 15:17:57 -07:00
llvm-remarkutil - Remark utility
Fix the LLVM sphinx build This addresses the failures found in: https://lab.llvm.org/buildbot/#/builders/30/builds/25899
2022-09-13 08:17:55 -04:00
================================
Add a utility for converting between different types of remarks This adds llvm-remarkutil. This is intended to be a general tool for doing stuff with/to remark files. This patch gives it the following powers: * `bitstream2yaml` - To convert bitstream remarks to YAML * `yaml2bitstream` - To convert YAML remarks to bitstream remarks These are both implemented as subcommands, like `llvm-remarkutil bitstream2yaml <input_file> -o -` I ran into an issue where I had some bitstream remarks coming from CI, and I wanted to be able to do stuff with them (e.g. visualize them). But then I noticed we didn't have any tooling for doing that, so I decided to write this thing. Being able to output YAML as a start seemed like a good idea, since it would allow people to reuse any tooling they may have written based around YAML remarks. Hopefully it can grow into a more featureful remark utility. :) Currently there are is an outstanding performance issue (see the TODO) with the bitstream2yaml case. I decided that I'd keep the tool small to start with and have the yaml2bitstream and bitstream2yaml cases be symmetric. Also I moved the remarks documentation to its own header because it seems a little out of place with "basic commands" and "developer tools"; it's really kind of its own thing. Differential Revision: https://reviews.llvm.org/D133646
2022-09-09 19:58:02 -07:00
.. 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.
[llvm-remarkutil] Add an option to print out function sizes This adds an `instruction-count` command to llvm-remarkutil. ``` llvm-remarkutil instruction-count --parser=<bitstream|yaml> <file> ``` This will, for now, only print out asm-printer `InstructionCount` remarks. Frequently I need to find out things like "what are the top 10 largest functions" in a given project. This makes it so we can find that information quickly and easily from any format of remarks. I chose a CSV because I usually want to stick these into a spreadsheet, and the data is two-dimensional. In the future, we may want to change this to another format if we add more complicated data. Differential Revision: https://reviews.llvm.org/D134765
2022-09-27 14:26:37 -07:00
* :ref:`instruction-count_subcommand` - Output function instruction counts.
Recommit "Add an option to print out annotation remark count." Add missing new line for `llvm/docs/CommandGuide/llvm-remarkutil.rst` This reverts commit 0f7fcb4c670fbef2c25b835fdfdd29598c6c13ae.
2023-04-07 23:42:39 +01:00
* :ref:`annotation-count_subcommand` - Output remark type count from annotation remarks.
[llvm-remarkutil] Add missing new line for `llvm/docs/CommandGuide/llvm-remarkutil.rst`
2023-04-07 23:45:45 +01:00
Add a utility for converting between different types of remarks This adds llvm-remarkutil. This is intended to be a general tool for doing stuff with/to remark files. This patch gives it the following powers: * `bitstream2yaml` - To convert bitstream remarks to YAML * `yaml2bitstream` - To convert YAML remarks to bitstream remarks These are both implemented as subcommands, like `llvm-remarkutil bitstream2yaml <input_file> -o -` I ran into an issue where I had some bitstream remarks coming from CI, and I wanted to be able to do stuff with them (e.g. visualize them). But then I noticed we didn't have any tooling for doing that, so I decided to write this thing. Being able to output YAML as a start seemed like a good idea, since it would allow people to reuse any tooling they may have written based around YAML remarks. Hopefully it can grow into a more featureful remark utility. :) Currently there are is an outstanding performance issue (see the TODO) with the bitstream2yaml case. I decided that I'd keep the tool small to start with and have the yaml2bitstream and bitstream2yaml cases be symmetric. Also I moved the remarks documentation to its own header because it seems a little out of place with "basic commands" and "developer tools"; it's really kind of its own thing. Differential Revision: https://reviews.llvm.org/D133646
2022-09-09 19:58:02 -07:00
.. _bitstream2yaml_subcommand:
bitstream2yaml
Fix the LLVM sphinx build This addresses the failures found in: https://lab.llvm.org/buildbot/#/builders/30/builds/25899
2022-09-13 08:17:55 -04:00
~~~~~~~~~~~~~~
Add a utility for converting between different types of remarks This adds llvm-remarkutil. This is intended to be a general tool for doing stuff with/to remark files. This patch gives it the following powers: * `bitstream2yaml` - To convert bitstream remarks to YAML * `yaml2bitstream` - To convert YAML remarks to bitstream remarks These are both implemented as subcommands, like `llvm-remarkutil bitstream2yaml <input_file> -o -` I ran into an issue where I had some bitstream remarks coming from CI, and I wanted to be able to do stuff with them (e.g. visualize them). But then I noticed we didn't have any tooling for doing that, so I decided to write this thing. Being able to output YAML as a start seemed like a good idea, since it would allow people to reuse any tooling they may have written based around YAML remarks. Hopefully it can grow into a more featureful remark utility. :) Currently there are is an outstanding performance issue (see the TODO) with the bitstream2yaml case. I decided that I'd keep the tool small to start with and have the yaml2bitstream and bitstream2yaml cases be symmetric. Also I moved the remarks documentation to its own header because it seems a little out of place with "basic commands" and "developer tools"; it's really kind of its own thing. Differential Revision: https://reviews.llvm.org/D133646
2022-09-09 19:58:02 -07:00
.. program:: llvm-remarkutil bitstream2yaml
USAGE: :program:`llvm-remarkutil` bitstream2yaml <input file> -o <output file>
Summary
Fix the LLVM sphinx build This addresses the failures found in: https://lab.llvm.org/buildbot/#/builders/30/builds/25899
2022-09-13 08:17:55 -04:00
^^^^^^^
Add a utility for converting between different types of remarks This adds llvm-remarkutil. This is intended to be a general tool for doing stuff with/to remark files. This patch gives it the following powers: * `bitstream2yaml` - To convert bitstream remarks to YAML * `yaml2bitstream` - To convert YAML remarks to bitstream remarks These are both implemented as subcommands, like `llvm-remarkutil bitstream2yaml <input_file> -o -` I ran into an issue where I had some bitstream remarks coming from CI, and I wanted to be able to do stuff with them (e.g. visualize them). But then I noticed we didn't have any tooling for doing that, so I decided to write this thing. Being able to output YAML as a start seemed like a good idea, since it would allow people to reuse any tooling they may have written based around YAML remarks. Hopefully it can grow into a more featureful remark utility. :) Currently there are is an outstanding performance issue (see the TODO) with the bitstream2yaml case. I decided that I'd keep the tool small to start with and have the yaml2bitstream and bitstream2yaml cases be symmetric. Also I moved the remarks documentation to its own header because it seems a little out of place with "basic commands" and "developer tools"; it's really kind of its own thing. Differential Revision: https://reviews.llvm.org/D133646
2022-09-09 19:58:02 -07:00
Takes a bitstream remark file as input, and reserializes that file as YAML.
.. _yaml2bitstream_subcommand:
yaml2bitstream
Fix the LLVM sphinx build This addresses the failures found in: https://lab.llvm.org/buildbot/#/builders/30/builds/25899
2022-09-13 08:17:55 -04:00
~~~~~~~~~~~~~~
Add a utility for converting between different types of remarks This adds llvm-remarkutil. This is intended to be a general tool for doing stuff with/to remark files. This patch gives it the following powers: * `bitstream2yaml` - To convert bitstream remarks to YAML * `yaml2bitstream` - To convert YAML remarks to bitstream remarks These are both implemented as subcommands, like `llvm-remarkutil bitstream2yaml <input_file> -o -` I ran into an issue where I had some bitstream remarks coming from CI, and I wanted to be able to do stuff with them (e.g. visualize them). But then I noticed we didn't have any tooling for doing that, so I decided to write this thing. Being able to output YAML as a start seemed like a good idea, since it would allow people to reuse any tooling they may have written based around YAML remarks. Hopefully it can grow into a more featureful remark utility. :) Currently there are is an outstanding performance issue (see the TODO) with the bitstream2yaml case. I decided that I'd keep the tool small to start with and have the yaml2bitstream and bitstream2yaml cases be symmetric. Also I moved the remarks documentation to its own header because it seems a little out of place with "basic commands" and "developer tools"; it's really kind of its own thing. Differential Revision: https://reviews.llvm.org/D133646
2022-09-09 19:58:02 -07:00
.. program:: llvm-remarkutil yaml2bitstream
USAGE: :program:`llvm-remarkutil` yaml2bitstream <input file> -o <output file>
Summary
Fix the LLVM sphinx build This addresses the failures found in: https://lab.llvm.org/buildbot/#/builders/30/builds/25899
2022-09-13 08:17:55 -04:00
^^^^^^^
Add a utility for converting between different types of remarks This adds llvm-remarkutil. This is intended to be a general tool for doing stuff with/to remark files. This patch gives it the following powers: * `bitstream2yaml` - To convert bitstream remarks to YAML * `yaml2bitstream` - To convert YAML remarks to bitstream remarks These are both implemented as subcommands, like `llvm-remarkutil bitstream2yaml <input_file> -o -` I ran into an issue where I had some bitstream remarks coming from CI, and I wanted to be able to do stuff with them (e.g. visualize them). But then I noticed we didn't have any tooling for doing that, so I decided to write this thing. Being able to output YAML as a start seemed like a good idea, since it would allow people to reuse any tooling they may have written based around YAML remarks. Hopefully it can grow into a more featureful remark utility. :) Currently there are is an outstanding performance issue (see the TODO) with the bitstream2yaml case. I decided that I'd keep the tool small to start with and have the yaml2bitstream and bitstream2yaml cases be symmetric. Also I moved the remarks documentation to its own header because it seems a little out of place with "basic commands" and "developer tools"; it's really kind of its own thing. Differential Revision: https://reviews.llvm.org/D133646
2022-09-09 19:58:02 -07:00
Takes a YAML remark file as input, and reserializes that file in the bitstream
format.
[llvm-remarkutil] Add an option to print out function sizes This adds an `instruction-count` command to llvm-remarkutil. ``` llvm-remarkutil instruction-count --parser=<bitstream|yaml> <file> ``` This will, for now, only print out asm-printer `InstructionCount` remarks. Frequently I need to find out things like "what are the top 10 largest functions" in a given project. This makes it so we can find that information quickly and easily from any format of remarks. I chose a CSV because I usually want to stick these into a spreadsheet, and the data is two-dimensional. In the future, we may want to change this to another format if we add more complicated data. Differential Revision: https://reviews.llvm.org/D134765
2022-09-27 14:26:37 -07:00
.. _instruction-count_subcommand:
instruction-count
~~~~~~~~~~~~~~~~~
.. program:: llvm-remarkutil instruction-count
[llvm-remarkutil] Add an option to display DebugLoc when collecting counts for remarks. Reviewed By: paquette Differential Revision: https://reviews.llvm.org/D148374
2023-04-18 13:48:41 +01:00
USAGE: :program:`llvm-remarkutil` instruction-count <input file> --parser=<bitstream|yaml> [--use-debug-loc] -o <output file>
[llvm-remarkutil] Add an option to print out function sizes This adds an `instruction-count` command to llvm-remarkutil. ``` llvm-remarkutil instruction-count --parser=<bitstream|yaml> <file> ``` This will, for now, only print out asm-printer `InstructionCount` remarks. Frequently I need to find out things like "what are the top 10 largest functions" in a given project. This makes it so we can find that information quickly and easily from any format of remarks. I chose a CSV because I usually want to stick these into a spreadsheet, and the data is two-dimensional. In the future, we may want to change this to another format if we add more complicated data. Differential Revision: https://reviews.llvm.org/D134765
2022-09-27 14:26:37 -07:00
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
Recommit "Add an option to print out annotation remark count." Add missing new line for `llvm/docs/CommandGuide/llvm-remarkutil.rst` This reverts commit 0f7fcb4c670fbef2c25b835fdfdd29598c6c13ae.
2023-04-07 23:42:39 +01:00
[llvm-remarkutil] Add an option to display DebugLoc when collecting counts for remarks. Reviewed By: paquette Differential Revision: https://reviews.llvm.org/D148374
2023-04-18 13:48:41 +01:00
if `--use-debug-loc` is passed then the CSV will include the source path, line number and column.
::
Source,Function,InstructionCount
path:line:column,foo,3
[Docs][llvm-remarkutil] Fix dangling reference in documentation 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.
2023-04-08 07:45:55 +00:00
.. _annotation-count_subcommand:
Recommit "Add an option to print out annotation remark count." Add missing new line for `llvm/docs/CommandGuide/llvm-remarkutil.rst` This reverts commit 0f7fcb4c670fbef2c25b835fdfdd29598c6c13ae.
2023-04-07 23:42:39 +01:00
annotation-count
~~~~~~~~~~~~~~~~~
.. program:: llvm-remarkutil annotation-count
[llvm-remarkutil] Add an option to display DebugLoc when collecting counts for remarks. Reviewed By: paquette Differential Revision: https://reviews.llvm.org/D148374
2023-04-18 13:48:41 +01:00
USAGE: :program:`llvm-remarkutil` annotation-count <input file> --parser=<bitstream|yaml> --annotation-type=<type> [--use-debug-loc] -o <output file>
Recommit "Add an option to print out annotation remark count." Add missing new line for `llvm/docs/CommandGuide/llvm-remarkutil.rst` This reverts commit 0f7fcb4c670fbef2c25b835fdfdd29598c6c13ae.
2023-04-07 23:42:39 +01:00
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
[llvm-remarkutil] Add an option to display DebugLoc when collecting counts for remarks. Reviewed By: paquette Differential Revision: https://reviews.llvm.org/D148374
2023-04-18 13:48:41 +01:00
if `--use-debug-loc` is passed then the CSV will include the source path, line number and column.
::
Source,Function,Count
path:line:column,foo,3
Reference in New Issue Copy Permalink