Author: bogner Date: Wed Jul 30 17:43:59 2014 New Revision: 214353 URL: http://llvm.org/viewvc/llvm-project?rev=214353&view=rev Log: Merging r214331: ------------------------------------------------------------------------ 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 ------------------------------------------------------------------------ Modified: llvm/branches/release_35/ (props changed) llvm/branches/release_35/docs/CommandGuide/llvm-profdata.rst Propchange: llvm/branches/release_35/ ------------------------------------------------------------------------------ --- svn:mergeinfo (original) +++ svn:mergeinfo Wed Jul 30 17:43:59 2014 @@ -1,3 +1,3 @@ /llvm/branches/Apple/Pertwee:110850,110961 /llvm/branches/type-system-rewrite:133420-134817 -/llvm/trunk:155241,213653,213749,213773,213793,213815,213847,213880,213884,213894-213895,213915,214129,214180,214287 +/llvm/trunk:155241,213653,213749,213773,213793,213815,213847,213880,213884,213894-213895,213915,214129,214180,214287,214331 Modified: llvm/branches/release_35/docs/CommandGuide/llvm-profdata.rst URL: http://llvm.org/viewvc/llvm-project/llvm/branches/release_35/docs/CommandGuide/llvm-profdata.rst?rev=214353&r1=214352&r2=214353&view=diff ============================================================================== --- llvm/branches/release_35/docs/CommandGuide/llvm-profdata.rst (original) +++ llvm/branches/release_35/docs/CommandGuide/llvm-profdata.rst Wed Jul 30 17:43:59 2014 @@ -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. _______________________________________________ llvm-branch-commits mailing list [email protected] http://lists.cs.uiuc.edu/mailman/listinfo/llvm-branch-commits
