diff options
author | Duncan P. N. Exon Smith <dexonsmith@apple.com> | 2014-02-17 23:22:49 +0000 |
---|---|---|
committer | Duncan P. N. Exon Smith <dexonsmith@apple.com> | 2014-02-17 23:22:49 +0000 |
commit | 846a627f5ca4cc72d4256c3b6b2051a49e13eb89 (patch) | |
tree | 35c756f4b20a469e2cd9fd4f5ba1f60ade11c66d /llvm/docs/CommandGuide/llvm-profdata.rst | |
parent | 551365da338bb7ef54943cb7e10cf595524d2ff9 (diff) | |
download | bcm5719-llvm-846a627f5ca4cc72d4256c3b6b2051a49e13eb89.tar.gz bcm5719-llvm-846a627f5ca4cc72d4256c3b6b2051a49e13eb89.zip |
PGO: llvm-profdata: tool for merging profiles
Introducing llvm-profdata, a tool for merging profile data generated by
PGO instrumentation in clang.
- The name indicates a file extension of <name>.profdata. Eventually
profile data output by clang should be changed to that extension.
- llvm-profdata merges two profiles. However, the name is more general,
since it will likely pick up more tasks (such as summarizing a single
profile).
- llvm-profdata parses the current text-based format, but will be
updated once we settle on a binary format.
<rdar://problem/15949645>
llvm-svn: 201535
Diffstat (limited to 'llvm/docs/CommandGuide/llvm-profdata.rst')
-rw-r--r-- | llvm/docs/CommandGuide/llvm-profdata.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/llvm/docs/CommandGuide/llvm-profdata.rst b/llvm/docs/CommandGuide/llvm-profdata.rst new file mode 100644 index 00000000000..6b8e4d7ed5b --- /dev/null +++ b/llvm/docs/CommandGuide/llvm-profdata.rst @@ -0,0 +1,29 @@ +llvm-profdata - work with profile data +====================================== + +SYNOPSIS +-------- + +:program:`llvm-profdata` [-output=output] file1 file2 + +DESCRIPTION +----------- + +The experimental :program:`llvm-profdata` tool reads two profile data files +generated by PGO instrumentation and generates a file with merged data. + +The profile data format itself is currently textual. + +OPTIONS +------- + +.. option:: -output=output + + This option selects the output filename. If not specified, output is to + stdout. + +EXIT STATUS +----------- + +:program:`llvm-profdata` returns 1 if it cannot read input files or there is a +mismatch between their data. |