summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDuncan P. N. Exon Smith <dexonsmith@apple.com>2014-02-17 23:22:49 +0000
committerDuncan P. N. Exon Smith <dexonsmith@apple.com>2014-02-17 23:22:49 +0000
commitddc5a010a40a7b85a020a072f9f6b4ae132e94bd (patch)
tree147cfb9555bac4adf6f6ef5a9c5cf3a8dcf69b7e /docs
parent4959a2d8780bb6a2424a0bb82df45d5150cef228 (diff)
downloadllvm-ddc5a010a40a7b85a020a072f9f6b4ae132e94bd.tar.gz
llvm-ddc5a010a40a7b85a020a072f9f6b4ae132e94bd.tar.bz2
llvm-ddc5a010a40a7b85a020a072f9f6b4ae132e94bd.tar.xz
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> git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@201535 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/CommandGuide/index.rst1
-rw-r--r--docs/CommandGuide/llvm-profdata.rst29
2 files changed, 30 insertions, 0 deletions
diff --git a/docs/CommandGuide/index.rst b/docs/CommandGuide/index.rst
index d799941aea..ab4788aee7 100644
--- a/docs/CommandGuide/index.rst
+++ b/docs/CommandGuide/index.rst
@@ -25,6 +25,7 @@ Basic Commands
llvm-config
llvm-diff
llvm-cov
+ llvm-profdata
llvm-stress
llvm-symbolizer
diff --git a/docs/CommandGuide/llvm-profdata.rst b/docs/CommandGuide/llvm-profdata.rst
new file mode 100644
index 0000000000..6b8e4d7ed5
--- /dev/null
+++ b/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.