6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2025-07-25 13:24:46 +00:00
Code Issues Projects Releases Wiki Activity

Merging r214331:

Browse Source 
------------------------------------------------------------------------
r214331 | arphaman | 2014-07-30 13:30:11 -0700 (Wed, 30 Jul 2014) | 4 lines

docs: update the command guide documentation for llvm-profdata.

Differential Revision: http://reviews.llvm.org/D4726

------------------------------------------------------------------------


git-svn-id: https://llvm.org/svn/llvm-project/llvm/branches/release_35@214353 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Justin Bogner
2014-07-30 22:43:59 +00:00
parent 031d076156
commit c81d1326ac
1 changed files with 85 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
docs/CommandGuide/llvm-profdata.rst
View File

@@ -1,29 +1,102 @@
llvm-profdata - work with profile data llvm-profdata - Profile data tool
====================================== =================================
SYNOPSIS SYNOPSIS
-------- --------
:program:`llvm-profdata` [-output=output] file1 file2 :program:`llvm-profdata` *command* [*args...*]
DESCRIPTION DESCRIPTION
----------- -----------
The experimental :program:`llvm-profdata` tool reads two profile data files The :program:`llvm-profdata` tool is a small utility for working with profile
generated by PGO instrumentation and generates a file with merged data. data files.
The profile data format itself is currently textual. COMMANDS
--------
* `merge <profdata_merge_>`_
* `show <profdata_show_>`_
.. program:: llvm-profdata merge
.. _profdata_merge:
MERGE
-----
SYNOPSIS
^^^^^^^^
:program:`llvm-profdata merge` [*options*] [*filenames...*]
DESCRIPTION
^^^^^^^^^^^
:program:`llvm-profdata merge` takes several profile data files
generated by PGO instrumentation and merges them together into a single
indexed profile data file.
OPTIONS OPTIONS
------- ^^^^^^^
.. option:: -output=output .. option:: -help
This option selects the output filename. If not specified, output is to Print a summary of command line options.
stdout.
.. option:: -output=output, -o=output
Specify the output file name. *Output* cannot be ``-`` as the resulting
indexed profile data can't be written to standard output.
.. program:: llvm-profdata show
.. _profdata_show:
SHOW
----
SYNOPSIS
^^^^^^^^
:program:`llvm-profdata show` [*options*] [*filename*]
DESCRIPTION
^^^^^^^^^^^
:program:`llvm-profdata show` takes a profile data file and displays the
information about the profile counters for this file and
for any of the specified function(s).
If *filename* is omitted or is ``-``, then **llvm-profdata show** reads its
input from standard input.
OPTIONS
^^^^^^^
.. option:: -all-functions
Print details for every function.
.. option:: -counts
Print the counter values for the displayed functions.
.. option:: -function=string
Print details for a function if the function's name contains the given string.
.. option:: -help
Print a summary of command line options.
.. option:: -output=output, -o=output
Specify the output file name. If *output* is ``-`` or it isn't specified,
then the output is sent to standard output.
EXIT STATUS EXIT STATUS
----------- -----------
:program:`llvm-profdata` returns 1 if it cannot read input files or there is a :program:`llvm-profdata` returns 1 if the command is omitted or is invalid,
mismatch between their data. if it cannot read input files, or if there is a mismatch between their data.