aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CommandGuide
diff options
context:
space:
mode:
authorDmitri Gribenko <gribozavr@gmail.com>2012-11-29 19:10:21 +0000
committerDmitri Gribenko <gribozavr@gmail.com>2012-11-29 19:10:21 +0000
commit90d0e7e8be2dea641ca40ba86c14c08d429e5e76 (patch)
treec3bc60df41d01ac4832316e3b405ad8fdcf86894 /docs/CommandGuide
parent7d4253af167479759fa5a71b7607b40033b96492 (diff)
downloadexternal_llvm-90d0e7e8be2dea641ca40ba86c14c08d429e5e76.zip
external_llvm-90d0e7e8be2dea641ca40ba86c14c08d429e5e76.tar.gz
external_llvm-90d0e7e8be2dea641ca40ba86c14c08d429e5e76.tar.bz2
Documentation for llvm-cov: reformat
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168922 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide')
-rw-r--r--docs/CommandGuide/llvm-cov.rst40
1 files changed, 14 insertions, 26 deletions
diff --git a/docs/CommandGuide/llvm-cov.rst b/docs/CommandGuide/llvm-cov.rst
index 09275f6..524f240 100644
--- a/docs/CommandGuide/llvm-cov.rst
+++ b/docs/CommandGuide/llvm-cov.rst
@@ -1,51 +1,39 @@
llvm-cov - emit coverage information
====================================
-
SYNOPSIS
--------
-
-**llvm-cov** [-gcno=filename] [-gcda=filename] [dump]
-
+:program:`llvm-cov` [-gcno=filename] [-gcda=filename] [dump]
DESCRIPTION
-----------
-
-The experimental **llvm-cov** tool reads in description file generated by compiler
-and coverage data file generated by instrumented program. This program assumes
-that the description and data file uses same format as gcov files.
-
+The experimental :program:`llvm-cov` tool reads in description file generated
+by compiler and coverage data file generated by instrumented program. This
+program assumes that the description and data file uses same format as gcov
+files.
OPTIONS
-------
+.. option:: -gcno=filename
+ This option selects input description file generated by compiler while
+ instrumenting program.
-**-gcno=filename]**
-
- This option selects input description file generated by compiler while instrumenting
- program.
-
-
-
-**-gcda=filename]**
+.. option:: -gcda=filename
This option selects coverage data file generated by instrumented compiler.
+.. option:: -dump
-
-**-dump**
-
- This options enables output dump that is suitable for a developer to help debug
- **llvm-cov** itself.
-
-
-
+ This options enables output dump that is suitable for a developer to help
+ debug :program:`llvm-cov` itself.
EXIT STATUS
-----------
+:program:`llvm-cov` returns 1 if it cannot read input files. Otherwise, it
+exits with zero.
-**llvm-cov** returns 1 if it cannot read input files. Otherwise, it exits with zero.