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.

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index d23ebff..f4424c6 100644 (file)
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,9 @@
+2020-05-11  Martin Liska  <mliska@suse.cz>
+
+       PR gcov-profile/94928
+       * gcov-io.h: Add caveat about coverage format parsing and
+       possible outdated documentation.
+
 2020-05-11  Xiong Hu Luo  <luoxhu@linux.ibm.com>
 
        PR tree-optimization/83403

diff --git a/gcc/gcov-io.h b/gcc/gcov-io.h
index d21a43c..ef888f3 100644 (file)
--- 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