diff options
author | Stephen Hines <srhines@google.com> | 2014-12-01 14:51:49 -0800 |
---|---|---|
committer | Stephen Hines <srhines@google.com> | 2014-12-02 16:08:10 -0800 |
commit | 37ed9c199ca639565f6ce88105f9e39e898d82d0 (patch) | |
tree | 8fb36d3910e3ee4c4e1b7422f4f017108efc52f5 /docs/CommandGuide/llvm-profdata.rst | |
parent | d2327b22152ced7bc46dc629fc908959e8a52d03 (diff) | |
download | external_llvm-37ed9c199ca639565f6ce88105f9e39e898d82d0.zip external_llvm-37ed9c199ca639565f6ce88105f9e39e898d82d0.tar.gz external_llvm-37ed9c199ca639565f6ce88105f9e39e898d82d0.tar.bz2 |
Update aosp/master LLVM for rebase to r222494.
Change-Id: Ic787f5e0124df789bd26f3f24680f45e678eef2d
Diffstat (limited to 'docs/CommandGuide/llvm-profdata.rst')
-rw-r--r-- | docs/CommandGuide/llvm-profdata.rst | 97 |
1 files changed, 85 insertions, 12 deletions
diff --git a/docs/CommandGuide/llvm-profdata.rst b/docs/CommandGuide/llvm-profdata.rst index 6b8e4d7..0762e2c 100644 --- a/docs/CommandGuide/llvm-profdata.rst +++ b/docs/CommandGuide/llvm-profdata.rst @@ -1,29 +1,102 @@ -llvm-profdata - work with profile data -====================================== +llvm-profdata - Profile data tool +================================= SYNOPSIS -------- -:program:`llvm-profdata` [-output=output] file1 file2 +:program:`llvm-profdata` *command* [*args...*] DESCRIPTION ----------- -The experimental :program:`llvm-profdata` tool reads two profile data files -generated by PGO instrumentation and generates a file with merged data. +The :program:`llvm-profdata` tool is a small utility for working with profile +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 -------- +^^^^^^^ + +.. option:: -help + + Print a summary of command line options. + +.. 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 +.. option:: -output=output, -o=output - This option selects the output filename. If not specified, output is to - stdout. + Specify the output file name. If *output* is ``-`` or it isn't specified, + then the output is sent to standard output. EXIT STATUS ----------- -:program:`llvm-profdata` returns 1 if it cannot read input files or there is a -mismatch between their data. +:program:`llvm-profdata` returns 1 if the command is omitted or is invalid, +if it cannot read input files, or if there is a mismatch between their data. |