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

[Justin Bogner]

I've gone ahead and merged this to the 3.5 branch in r214353. Thanks!

Alex Lorenz <arphaman at gmail.com> writes:
> Author: arphaman
> Date: Wed Jul 30 15:30:11 2014
> New Revision: 214331
>
> URL: http://llvm.org/viewvc/llvm-project?rev=214331&view=revLog:
> docs: update the command guide documentation for llvm-profdata.
>
> Differential Revision: http://reviews.llvm.org/D4726
>
> Modified:
>     llvm/trunk/docs/CommandGuide/llvm-profdata.rst
>
> Modified: llvm/trunk/docs/CommandGuide/llvm-profdata.rst
> URL:
> http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-profdata.rst?rev=214331&r1=214330&r2=214331&view=diff==============================================================================
> --- llvm/trunk/docs/CommandGuide/llvm-profdata.rst (original)
> +++ llvm/trunk/docs/CommandGuide/llvm-profdata.rst Wed Jul 30 15:30:11 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-commits mailing list
> llvm-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits