diff mbox series

gcov: Reword comment for gcov_read_string()

Message ID 20220331065500.25015-1-sebastian.huber@embedded-brains.de
State New
Headers show
Series gcov: Reword comment for gcov_read_string() | expand

Commit Message

Sebastian Huber March 31, 2022, 6:55 a.m. UTC
gcc/

	* gcov-io.cc (gcov_read_string): Reword documentation comment.
---
 gcc/gcov-io.cc | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Martin Liška March 31, 2022, 6:57 a.m. UTC | #1
On 3/31/22 08:55, Sebastian Huber wrote:
> gcc/
> 
> 	* gcov-io.cc (gcov_read_string): Reword documentation comment.
> ---
>   gcc/gcov-io.cc | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/gcc/gcov-io.cc b/gcc/gcov-io.cc
> index c2e9e2b6d64..72c40f8eaa0 100644
> --- a/gcc/gcov-io.cc
> +++ b/gcc/gcov-io.cc
> @@ -473,9 +473,9 @@ mangle_path (char const *base)
>   /* We need to expose the below function when compiling for gcov-tool.  */
>   
>   #if !IN_LIBGCOV || defined (IN_GCOV_TOOL)
> -/* Read string from coverage file. Returns a pointer to a static
> -   buffer, or NULL on empty string. You must copy the string before
> -   calling another gcov function.  */
> +/* Read string from coverage file.  Allocate the buffer for the string
> +   from the heap or die.  Return a pointer to the string, or NULL on
> +   empty string.  */
>   
>   GCOV_LINKAGE const char *
>   gcov_read_string (void)

Ready for master, thanks!

Martin
diff mbox series

Patch

diff --git a/gcc/gcov-io.cc b/gcc/gcov-io.cc
index c2e9e2b6d64..72c40f8eaa0 100644
--- a/gcc/gcov-io.cc
+++ b/gcc/gcov-io.cc
@@ -473,9 +473,9 @@  mangle_path (char const *base)
 /* We need to expose the below function when compiling for gcov-tool.  */
 
 #if !IN_LIBGCOV || defined (IN_GCOV_TOOL)
-/* Read string from coverage file. Returns a pointer to a static
-   buffer, or NULL on empty string. You must copy the string before
-   calling another gcov function.  */
+/* Read string from coverage file.  Allocate the buffer for the string
+   from the heap or die.  Return a pointer to the string, or NULL on
+   empty string.  */
 
 GCOV_LINKAGE const char *
 gcov_read_string (void)