aboutsummaryrefslogtreecommitdiff
path: root/gcc/gcov-io.h
diff options
context:
space:
mode:
authorMartin Liska <mliska@suse.cz>2020-05-11 09:25:46 +0200
committerMartin Liska <mliska@suse.cz>2020-05-11 09:25:46 +0200
commit10a9bf806cf180915c20f9971d33da8ff2d663c1 (patch)
treea28e84469c45266d6670d0473fa44afef51dfe2d /gcc/gcov-io.h
parent0447929f11e6a3e1b076841712b90a8b6bc7d33a (diff)
downloadgcc-10a9bf806cf180915c20f9971d33da8ff2d663c1.zip
gcc-10a9bf806cf180915c20f9971d33da8ff2d663c1.tar.gz
gcc-10a9bf806cf180915c20f9971d33da8ff2d663c1.tar.bz2
Add caveat about parsing of .gcda and .gcno files.
PR gcov-profile/94928 * gcov-io.h: Add caveat about coverage format parsing and possible outdated documentation.
Diffstat (limited to 'gcc/gcov-io.h')
-rw-r--r--gcc/gcov-io.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/gcc/gcov-io.h b/gcc/gcov-io.h
index d21a43c..ef888f3 100644
--- a/gcc/gcov-io.h
+++ b/gcc/gcov-io.h
@@ -25,7 +25,13 @@ see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
<http://www.gnu.org/licenses/>. */
-/* Coverage information is held in two files. A notes file, which is
+/* CAVEAT: Coverage information files should not be parsed directly,
+ instead use `gcov --json-format`, which provides
+ machine-readable coverage information.
+
+ Note that the following file format documentation might be outdated.
+
+ Coverage information is held in two files. A notes file, which is
generated by the compiler, and a data file, which is generated by
the program under test. Both files use a similar structure. We do
not attempt to make these files backwards compatible with previous