Make gcov docs more precise (PR gcov-profile/89959).

Message ID 5a2d6526-3b8c-9400-756c-8ea8eddc73f4@suse.cz
State New
Headers show
Series
  • Make gcov docs more precise (PR gcov-profile/89959).
Related show

Commit Message

Martin Liška April 8, 2019, 9:17 a.m.
Hi.

The patch is about option documentation improvement as seen in the PR.
I'm adding the reported to CC. I'll install it if there are no comments.

Martin

gcc/ChangeLog:

2019-04-08  Martin Liska  <mliska@suse.cz>

	PR gcov-profile/89959
	* doc/gcov.texi: Make documentation of -x option
	more precise.
---
 gcc/doc/gcov.texi | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Patch

diff --git a/gcc/doc/gcov.texi b/gcc/doc/gcov.texi
index ecad5d11847..0b8a1c78bfa 100644
--- a/gcc/doc/gcov.texi
+++ b/gcc/doc/gcov.texi
@@ -427,13 +427,15 @@  Print verbose informations related to basic blocks and arcs.
 
 @item -x
 @itemx --hash-filenames
-By default, gcov uses the full pathname of the source files to create
+When using @var{--preserve-paths},
+gcov uses the full pathname of the source files to create
 an output filename.  This can lead to long filenames that can overflow
 filesystem limits.  This option creates names of the form
 @file{@var{source-file}##@var{md5}.gcov},
 where the @var{source-file} component is the final filename part and
 the @var{md5} component is calculated from the full mangled name that
-would have been used otherwise.
+would have been used otherwise.  The option is an alternative
+to the @var{--preserve-paths} on systems which have a filesystem limit.
 
 @end table