[llvm-commits] [llvm] r168922 - /llvm/trunk/docs/CommandGuide/llvm-cov.rst
Dmitri Gribenko
gribozavr at gmail.com
Thu Nov 29 11:10:21 PST 2012
Author: gribozavr
Date: Thu Nov 29 13:10:21 2012
New Revision: 168922
URL: http://llvm.org/viewvc/llvm-project?rev=168922&view=rev
Log:
Documentation for llvm-cov: reformat
Modified:
llvm/trunk/docs/CommandGuide/llvm-cov.rst
Modified: llvm/trunk/docs/CommandGuide/llvm-cov.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-cov.rst?rev=168922&r1=168921&r2=168922&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-cov.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-cov.rst Thu Nov 29 13:10:21 2012
@@ -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.
More information about the llvm-commits
mailing list