vcoverage(1)

1VCOVERAGE(1)          User Contributed Perl Documentation         VCOVERAGE(1)
2
3
4

NAME

6       vcoverage - Verilog/SystemC coverage analyzer
7

SYNOPSIS

9        Create report:
10           vcoverage -f input.vc <datafile>
11        Merge reports
12           vcoverage --noreport -write <merged.dat>  <datafiles>
13

DESCRIPTION

15       Vcoverage reads the specified data file and generates annotated source
16       code with coverage metrics annotated.  By default logs/coverage.pl is
17       read.  If multiple coverage points exist on the same line, additional
18       lines will be inserted to report the additional points.
19
20       Additional Verilog-standard arguments specify the search paths
21       necessary to find the source code that the coverage analysis was
22       performed on.
23
24       To get correct coverage percentages, you may wish to read
25       logs/coverage.pl into Emacs and do a M-x keep-lines to include only
26       those statistics of interest.
27
28       For Verilog conditions that should never occur, you should add a $stop
29       statement.  This will remove the coverage during the next build.
30

ARGUMENTS

32       --all-files
33           Specifies all files should be shown.  By default, only those source
34           files which have low coverage are written to the output directory.
35
36       --help
37           Displays this message and program version and exits.
38
39       --min count
40           Specifies the minimum occurrence count that should be flagged if
41           the coverage point does not include a specified threshold.
42           Defaults to 10.
43
44       --noreport
45           Don't produce output files.  Used with --write to merge files.
46
47       --o output_directory
48           Sprcifies the directory name that source files with annotated
49           coverage data should be written to.
50
51       --unlink
52           When using --write to combine coverage data, unlink all input files
53           after the output has been created.
54
55       --version
56           Displays program version and exits.
57
58       --write filename
59           Specifies the aggregate coverage results, summed across all the
60           files, should be written to the given filename.  This is useful in
61           scripts to combine many sequential runs into one master coverage
62           file.
63

VERILOG ARGUMENTS

65       The following arguments are compatible with GCC, VCS and most Verilog
66       programs.
67
68       +libext+ext+ext...
69           Defines the extensions for Verilog files.
70
71       +define+var+value =item -Dvar=value
72           Defines the given variable.
73
74       +incdir+dir =item -Idir
75           Specifies a directory for finding include files.
76
77       -f file
78           Specifies a file containing additional command line arguments.
79
80       -y dir
81           Specifies a module search directory.
82

DISTRIBUTION

84       SystemPerl is part of the <http://www.veripool.org/> free SystemC
85       software tool suite.  The latest version is available from CPAN and
86       from <http://www.veripool.org/systemperl>.
87
88       Copyright 2001-2010 by Wilson Snyder.  This package is free software;
89       you can redistribute it and/or modify it under the terms of either the
90       GNU Lesser General Public License Version 3 or the Perl Artistic
91       License Version 2.0.
92

AUTHORS

94       Wilson Snyder <wsnyder@wsnyder.org>
95