/usr/share/doc/gnat-gps/html/Code-Coverage.html is in gnat-gps-doc 5.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | <html lang="en">
<head>
<title>Code Coverage - Using the GNAT Programming Studio</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Using the GNAT Programming Studio">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Tools.html#Tools" title="Tools">
<link rel="prev" href="Metrics.html#Metrics" title="Metrics">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2002-2010 AdaCore.
This document is free; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, see `http://www.gnu.org/licenses/'.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
pre.smallexample {background-color:rgb(240,240,240);
font-family: courier new,courier,fixed;
font-size: 14px;
margin: 0px 40px 0px 40px;
border-width: 1px 2px 2px 1px;
border-top-style: dotted;
border-left-style: dotted;
border-right-style: solid;
border-bottom-style: solid;
border-color: black;}
code {color:black;
font-family: courier new,courier,fixed;
font-size: 14px;}
body {font-family: arial,helvetica,sans-serif;
font-size: 16px;
max-width: 800px;
text-align: justify}
samp {font-family: courier new,courier,fixed;
font-size: 14px}
--></style>
</head>
<body>
<div class="node">
<a name="Code-Coverage"></a>
<p>
Previous: <a rel="previous" accesskey="p" href="Metrics.html#Metrics">Metrics</a>,
Up: <a rel="up" accesskey="u" href="Tools.html#Tools">Tools</a>
<hr>
</div>
<h3 class="section">13.7 Code Coverage</h3>
<p><a name="index-Code-Coverage-623"></a><!-- -->
<p>GPS is fitted with a strong integration of Gcov, the GNU code coverage
utility.
<p>Code coverage information can be computed from, loaded and visualized in GPS.
This can be done file by file, for each files of the current project,
project by project (in case of dependencies) or for the entire project hierarchy
currently used in GPS.
<p>Once computed then loaded, the coverage information is summarized in a
graphical report (shaped as a tree-view with percentage bars for each item)
and used to decorate source code through mechanisms such as line highlighting or
coverage annotations.
<p>All the coverage related operations are reachable via the
<samp><span class="command">Tools->Coverage</span></samp> menu.
<p>In order to be loaded in GPS, the coverage information need to be computed
before, using the <samp><span class="command">Tools->Coverage->Gcov->Compute coverage files</span></samp> menu
for instance.
<p>At each attempt, GPS automatically tries to load the needed information and
reports errors for missing or corrupted <samp><span class="command">.gcov</span></samp> files.
<p>To be able to produce coverage information from Gcov, your project must have
been compiled with the <samp><span class="command">-fprofile-arcs</span></samp> and <samp><span class="command">-ftest-coverage</span></samp>"
switches, respectively "Instrument arcs" and "Code coverage" entries in
<a href="The-Project-Properties-Editor.html#The-Project-Properties-Editor">The Project Properties Editor</a>, and run once.
<dl>
<dt><b><a href="The-Tools-Menu.html#The-Tools-Menu">The Tools Menu</a></b><dd>
The <samp><span class="command">Tools->Coverage</span></samp> menu have an incremental set of entries,
depending on the context.
<dl>
<dt><samp><span class="command">Coverage->Gcov->Compute coverage files</span></samp><dd>Generates the <samp><span class="command">.gcov</span></samp> files of current and properly compiled and run
projects.
<br><dt><samp><span class="command">Coverage->Gcov->Remove coverage files</span></samp><dd>Deletes all the <samp><span class="command">.gcov</span></samp> of current projects.
<!-- \hline -->
<br><dt><samp><span class="command">Coverage->Show report</span></samp><dd>Open a new window summarizing the coverage information currently loaded in GPS.
<!-- \hline -->
<br><dt><samp><span class="command">Coverage->Load data for all projects</span></samp><dd>Load or re-load the coverage information of every projects and subprojects.
<br><dt><samp><span class="command">Coverage->Load data for project </span><code>XXX</code></samp><dd>Load or re-load the coverage information of the project <code>XXX</code>.
<br><dt><samp><span class="command">Coverage->Load data for </span><samp><span class="file">xxxxxxxx.xxx</span></samp></samp><dd>Load or re-load the coverage information of the specified source file.
<!-- \hline -->
<br><dt><samp><span class="command">Coverage->Clear coverage from memory</span></samp><dd>Drop every coverage information loaded in GPS.
</dl>
<br><dt><b>The Contextual Menu</b><dd>
When clicking on a project, file or subprogram entity (including the entities
listed in the coverage report), you have access to a <samp><span class="command">Coverage</span></samp> submenu.
<p>These submenus contain the following entries, adapted to the context related
element. For instance, if you click on a file, you will have:
<dl>
<dt><samp><span class="command">Coverage->Show coverage information</span></samp><dd>Append an annotation column to the left side of the current source editor.
This column indicates which lines are covered and which aren't. Unexecuted lines
are also listed in the <a href="The-Locations-View.html#The-Locations-View">The Locations View</a>.
<br><dt><samp><span class="command">Coverage->Hide coverage information</span></samp><dd>Withdraw from the current source editor a previously set coverage annotation
column and clear <a href="The-Locations-View.html#The-Locations-View">The Locations View</a> from the eventually listed uncovered
lines.
<br><dt><samp><span class="command">Coverage->Load data for </span><samp><span class="file">xxxxxxxx.xxx</span></samp></samp><dd>Load or re-load the coverage information of the specified source file.
<br><dt><samp><span class="command">Coverage->Remove data of </span><samp><span class="file">xxxxxxxx.xxx</span></samp></samp><dd>Remove the coverage information of the specified source file from GPS memory.
<br><dt><samp><span class="command">Coverage->Show Coverage report</span></samp><dd>Open a new window summarizing the coverage information. (This entry appears
only if the contextual menu has been created from outside of the Coverage
Report.)
</dl>
<br><dt><b>The Coverage Report</b><dd><a name="Coverage-Report"></a>When coverage information are loaded into GPS, a graphical report of coverage
is displayed.
<p>This report contains a tree of Projects, Files and Subprograms with
corresponding coverage information for each node in sided columns.
<p><a name="index-screen-shot-624"></a><img src="report-of-analysis_tree.jpg" alt="report-of-analysis_tree.jpg">
<p>The contextual menus generated on this widget contain, in addition to the
regular entries, some specific Coverage Report entries.
<p>These entries allow you to expand or fold the tree, and also to display flat
lists of files or subprograms instead of the tree. A flat list of file will
look like:
<p><a name="index-screen-shot-625"></a><img src="report-of-analysis_flat.jpg" alt="report-of-analysis_flat.jpg">
</dl>
<p>GPS and Gcov both support many different programming languages, and so code
coverage features are available in GPS for many languages. But, note that
subprogram coverage details are not available for every supported languages.
<p>To finish, note that if you change the current main project in GPS, using the
<samp><span class="command">Project->Open</span></samp> menu for instance, you will also drop every loaded
coverage information as they are related to the working project.
<!-- -->
</body></html>
|