public inbox for gcc-cvs@sourceware.org
help / color / mirror / Atom feed
* [gcc(refs/users/marxin/heads/100751-gcov_dump-docs)] DOC: update documentation of __gcov_{dump, reset}
@ 2021-05-25  7:52 Martin Liska
  0 siblings, 0 replies; only message in thread
From: Martin Liska @ 2021-05-25  7:52 UTC (permalink / raw)
  To: gcc-cvs

https://gcc.gnu.org/g:ed8d32c681bd09002230921829e063891d60dc5a

commit ed8d32c681bd09002230921829e063891d60dc5a
Author: Martin Liska <mliska@suse.cz>
Date:   Tue May 25 09:52:01 2021 +0200

    DOC: update documentation of __gcov_{dump,reset}
    
    gcc/ChangeLog:
    
            PR gcov-profile/100751
            * doc/gcov.texi: Document that __gcov_dump can be called just
            once and that __gcov_reset resets run-time counters.

Diff:
---
 gcc/doc/gcov.texi | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/gcc/doc/gcov.texi b/gcc/doc/gcov.texi
index 1ad99e5569e..d076721b93c 100644
--- a/gcc/doc/gcov.texi
+++ b/gcc/doc/gcov.texi
@@ -885,13 +885,15 @@ same source lines, the line counts themselves might seem inconsistent.
 
 Long-running applications can use the @code{__gcov_reset} and @code{__gcov_dump}
 facilities to restrict profile collection to the program region of
-interest. Calling @code{__gcov_reset(void)} will clear all profile counters
-to zero, and calling @code{__gcov_dump(void)} will cause the profile information
-collected at that point to be dumped to @file{.gcda} output files.
+interest. Calling @code{__gcov_reset(void)} will clear all run-time profile
+counters to zero, and calling @code{__gcov_dump(void)} will cause the profile
+information collected at that point to be dumped to @file{.gcda} output files
+(the function can be called just once).
 Instrumented applications use a static destructor with priority 99
 to invoke the @code{__gcov_dump} function. Thus @code{__gcov_dump}
 is executed after all user defined static destructors,
 as well as handlers registered with @code{atexit}.
+
 If an executable loads a dynamic shared object via dlopen functionality,
 @option{-Wl,--dynamic-list-data} is needed to dump all profile data.


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2021-05-25  7:52 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-25  7:52 [gcc(refs/users/marxin/heads/100751-gcov_dump-docs)] DOC: update documentation of __gcov_{dump, reset} Martin Liska

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).