diff options
| author | Xinliang David Li <davidxl@google.com> | 2015-11-24 20:48:25 +0000 |
|---|---|---|
| committer | Xinliang David Li <davidxl@google.com> | 2015-11-24 20:48:25 +0000 |
| commit | 2fc2515519dab70fc38b24971c5a18c167278770 (patch) | |
| tree | eec005418f0862630155875d1d99bbb7d1560fa6 /llvm/docs/CommandGuide/llvm-profdata.rst | |
| parent | 990914d64c22c8465f01b69473f11004def124ce (diff) | |
| download | bcm5719-llvm-2fc2515519dab70fc38b24971c5a18c167278770.tar.gz bcm5719-llvm-2fc2515519dab70fc38b24971c5a18c167278770.zip | |
Fix sphinx-build error when building documentation.
Consolidate the description of -binary/-text option description
to avoid duplicate ID error by sphinux-build.
llvm-svn: 254018
Diffstat (limited to 'llvm/docs/CommandGuide/llvm-profdata.rst')
| -rw-r--r-- | llvm/docs/CommandGuide/llvm-profdata.rst | 26 |
1 files changed, 10 insertions, 16 deletions
diff --git a/llvm/docs/CommandGuide/llvm-profdata.rst b/llvm/docs/CommandGuide/llvm-profdata.rst index 1d46fe75467..210826a7bab 100644 --- a/llvm/docs/CommandGuide/llvm-profdata.rst +++ b/llvm/docs/CommandGuide/llvm-profdata.rst @@ -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 |
