From 10a9bf806cf180915c20f9971d33da8ff2d663c1 Mon Sep 17 00:00:00 2001 From: Martin Liska Date: Mon, 11 May 2020 09:25:46 +0200 Subject: [PATCH] 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. --- gcc/ChangeLog | 6 ++++++ gcc/gcov-io.h | 8 +++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/gcc/ChangeLog b/gcc/ChangeLog index d23ebff..f4424c6 100644 --- a/gcc/ChangeLog +++ b/gcc/ChangeLog @@ -1,3 +1,9 @@ +2020-05-11 Martin Liska + + PR gcov-profile/94928 + * gcov-io.h: Add caveat about coverage format parsing and + possible outdated documentation. + 2020-05-11 Xiong Hu Luo PR tree-optimization/83403 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 . */ -/* 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 -- 2.7.4