[llvm] r254018 - Fix sphinx-build error when building documentation.

Xinliang David Li via llvm-commits llvm-commits at lists.llvm.org
Tue Nov 24 12:48:25 PST 2015


Author: davidxl
Date: Tue Nov 24 14:48:25 2015
New Revision: 254018

URL: http://llvm.org/viewvc/llvm-project?rev=254018&view=rev
Log:
Fix sphinx-build error when building documentation.

Consolidate the description of -binary/-text option description
to avoid duplicate ID error by sphinux-build.

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=254018&r1=254017&r2=254018&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-profdata.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-profdata.rst Tue Nov 24 14:48:25 2015
@@ -51,31 +51,25 @@ OPTIONS
 
 .. option:: -instr (default)
 
- Specify that the input profile is an instrumentation-based profile. When
- using instrumentation-based profiles, the format of the generated file
- can be generated in one of the two ways:
-
- .. option:: -binary (default)
-
- Emit the profile using a binary encoding in indexed profile format.
-
- .. option:: -text
-
- Emit the profile in text format.
+ Specify that the input profile is an instrumentation-based profile.
 
 .. option:: -sample
 
- Specify that the input profile is a sample-based profile. When using
- sample-based profiles, the format of the generated file can be generated
- in one of three ways:
+ Specify that the input profile is a sample-based profile.
+ 
+ The format of the generated file can be generated in one of three ways:
 
  .. option:: -binary (default)
 
- Emit the profile using a binary encoding.
+ Emit the profile using a binary encoding. For instrumentation-based profile
+ the output format is the indexed binary format. 
 
  .. option:: -text
 
- Emit the profile in text mode.
+ Emit the profile in text mode. This option can also be used with both
+ sample-based and instrumentation-based profile. When this option is used
+ the profile will be dumped in the text format that is parsable by the profile
+ reader.
 
  .. option:: -gcc
 




More information about the llvm-commits mailing list