This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH] Add -fprofile-note option.


On 7/4/19 1:15 AM, Sandra Loosemore wrote:
On 7/2/19 6:37 AM, Martin Liška wrote:

@@ -12403,6 +12403,11 @@ the profile feedback data files. See @option{-fprofile-dir}.
 To optimize the program based on the collected profile information, use
 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.

+@item -fprofile-note=@var{path}
+@opindex fprofile-note
+
+If @var{path} is specified, GCC saves gcno filename into @var{path} location.
+
 @item -fprofile-update=@var{method}
 @opindex fprofile-update



Hi.


"gcno filename" is implementor-speak with no context.  In other places the documentation uses "@file{.gcno} file".  Please use that here as well, and add a @cindex entry on the main definition/discussion of these things and a cross-reference here.

Thank you for the comments. Yes, the suggested wording is much bettern.


I assume this option only makes sense with some other profiling options.  What are they?

Yes, I listed the option in the section.


Can there be more than one of these files per gcc invocation?  E.g. if you specify a command line like

gcc -c foo.c bar.c

??  It looks like the code part of the patch would cause the file to be overwritten.  Maybe this should be like -o and diagnose an error?

Yes, it can be combined, I added a caveat into documentation patch.

Martin


-Sandra


>From d1182429f5565a4e82f035af30ef98151fc36a48 Mon Sep 17 00:00:00 2001
From: Martin Liska <mliska@suse.cz>
Date: Mon, 8 Jul 2019 19:37:53 +0200
Subject: [PATCH] Enhance documentation of -fprofile-note option.

gcc/ChangeLog:

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

	* doc/invoke.texi: Add link from -fprofile-dir option.
	Use better wording for 'gcno filename'.
---
 gcc/doc/invoke.texi | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 73d16b59d91..6c1692eb4b7 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -12369,7 +12369,7 @@ profile data file appears in the same directory as the object file.
 In order to prevent the file name clashing, if the object file name is
 not an absolute path, we mangle the absolute path of the
 @file{@var{sourcename}.gcda} file and use it as the file name of a
-@file{.gcda} file.
+@file{.gcda} file.  See similar option @option{-fprofile-note}.
 
 When an executable is run in a massive parallel environment, it is recommended
 to save profile to different folders.  That can be done with variables
@@ -12407,7 +12407,9 @@ To optimize the program based on the collected profile information, use
 @item -fprofile-note=@var{path}
 @opindex fprofile-note
 
-If @var{path} is specified, GCC saves gcno filename into @var{path} location.
+If @var{path} is specified, GCC saves @file{.gcno} file into @var{path}
+location.  If you not combine the option with multiple source files,
+the @file{.gcno} file will be overwritten.
 
 @item -fprofile-update=@var{method}
 @opindex fprofile-update
-- 
2.22.0


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]