public inbox for gcc-bugs@sourceware.org
help / color / mirror / Atom feed
* [Bug c/96285] New: The documentation of -fprofile-exclude-files is unclear
@ 2020-07-22 13:25 goeran at uddeborg dot se
  2020-07-23  9:12 ` [Bug gcov-profile/96285] " marxin at gcc dot gnu.org
                   ` (4 more replies)
  0 siblings, 5 replies; 6+ messages in thread
From: goeran at uddeborg dot se @ 2020-07-22 13:25 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=96285

            Bug ID: 96285
           Summary: The documentation of -fprofile-exclude-files is
                    unclear
           Product: gcc
           Version: 10.1.0
            Status: UNCONFIRMED
          Severity: normal
          Priority: P3
         Component: c
          Assignee: unassigned at gcc dot gnu.org
          Reporter: goeran at uddeborg dot se
  Target Milestone: ---

During the translation of the help text for -fprofile-exclude-files a
discussion started what it actually meant.  Does the name has to match ALL the
regular expressions given, or just ANY of them, for the file to be excluded?

The texinfo documentation didn't help, since it just had an example with a
single expression.  Checking the code I figured out it is excluded if it
matches any of them.

Even if the current documentation actually say this, it is easy to
misunderstand.  May I suggest the documentation is clarified on this point? 
Perhaps simply

  Instrument only functions from files whose name does not match any of the
regular expressions (separated by semi-colons).

In addition, the texinfo documentation is probably slightly wrong.  It gives as
the example "/usr/*".  Treated as a regular expression, which indeed seems to
be what the code implements, that means "/usr" followed by an arbitrary number
of "/".  Not what was intended, I believe.  Maybe it might still work; from
what I can tell the search string isn't anchored so it is ok for it to match
only the beginning of the name.  But if so the "/*" at the end is pointless,
and the example could lead the reader to assume it is a glob expression rather
than a regular expression.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [Bug gcov-profile/96285] The documentation of -fprofile-exclude-files is unclear
  2020-07-22 13:25 [Bug c/96285] New: The documentation of -fprofile-exclude-files is unclear goeran at uddeborg dot se
@ 2020-07-23  9:12 ` marxin at gcc dot gnu.org
  2020-07-23 12:58 ` marxin at gcc dot gnu.org
                   ` (3 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: marxin at gcc dot gnu.org @ 2020-07-23  9:12 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=96285

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |ASSIGNED
     Ever confirmed|0                           |1
   Last reconfirmed|                            |2020-07-23
           Assignee|unassigned at gcc dot gnu.org      |marxin at gcc dot gnu.org

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [Bug gcov-profile/96285] The documentation of -fprofile-exclude-files is unclear
  2020-07-22 13:25 [Bug c/96285] New: The documentation of -fprofile-exclude-files is unclear goeran at uddeborg dot se
  2020-07-23  9:12 ` [Bug gcov-profile/96285] " marxin at gcc dot gnu.org
@ 2020-07-23 12:58 ` marxin at gcc dot gnu.org
  2020-07-24  8:31 ` goeran at uddeborg dot se
                   ` (2 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: marxin at gcc dot gnu.org @ 2020-07-23 12:58 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=96285

--- Comment #1 from Martin Liška <marxin at gcc dot gnu.org> ---
Hey Göran.

I like both your suggestions for the documentation update. Can you please send
a patch to the gcc-patches mailing list?

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [Bug gcov-profile/96285] The documentation of -fprofile-exclude-files is unclear
  2020-07-22 13:25 [Bug c/96285] New: The documentation of -fprofile-exclude-files is unclear goeran at uddeborg dot se
  2020-07-23  9:12 ` [Bug gcov-profile/96285] " marxin at gcc dot gnu.org
  2020-07-23 12:58 ` marxin at gcc dot gnu.org
@ 2020-07-24  8:31 ` goeran at uddeborg dot se
  2020-08-26 23:07 ` cvs-commit at gcc dot gnu.org
  2020-08-27  7:49 ` marxin at gcc dot gnu.org
  4 siblings, 0 replies; 6+ messages in thread
From: goeran at uddeborg dot se @ 2020-07-24  8:31 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=96285

--- Comment #2 from Göran Uddeborg <goeran at uddeborg dot se> ---
Sure, I'll put it together shortly.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [Bug gcov-profile/96285] The documentation of -fprofile-exclude-files is unclear
  2020-07-22 13:25 [Bug c/96285] New: The documentation of -fprofile-exclude-files is unclear goeran at uddeborg dot se
                   ` (2 preceding siblings ...)
  2020-07-24  8:31 ` goeran at uddeborg dot se
@ 2020-08-26 23:07 ` cvs-commit at gcc dot gnu.org
  2020-08-27  7:49 ` marxin at gcc dot gnu.org
  4 siblings, 0 replies; 6+ messages in thread
From: cvs-commit at gcc dot gnu.org @ 2020-08-26 23:07 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=96285

--- Comment #3 from CVS Commits <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Jeff Law <law@gcc.gnu.org>:

https://gcc.gnu.org/g:8ca43e4ea58ae436af4b5818916abc15b2fd8f49

commit r11-2891-g8ca43e4ea58ae436af4b5818916abc15b2fd8f49
Author: Göran Uddeborg <goeran@uddeborg.se>
Date:   Wed Aug 26 17:06:28 2020 -0600

    Fix documentation of -fprofile-exclude-files

    The wording of the description of -fprofile-exclude-files is easy to
    misunderstand.  One can be led to believe a file is excluded only if
    it matches all of the patterns, not just one.  This patch tries to
    clarify the function.  It also adjusts the wording of
    -fprofile-filter-files accordingly.

    gcc/

            PR gcov-profile/96285
            * common.opt, doc/invoke.texi: Clarify wording of
            -fprofile-exclude-files and adjust -fprofile-filter-files to
            match.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [Bug gcov-profile/96285] The documentation of -fprofile-exclude-files is unclear
  2020-07-22 13:25 [Bug c/96285] New: The documentation of -fprofile-exclude-files is unclear goeran at uddeborg dot se
                   ` (3 preceding siblings ...)
  2020-08-26 23:07 ` cvs-commit at gcc dot gnu.org
@ 2020-08-27  7:49 ` marxin at gcc dot gnu.org
  4 siblings, 0 replies; 6+ messages in thread
From: marxin at gcc dot gnu.org @ 2020-08-27  7:49 UTC (permalink / raw)
  To: gcc-bugs

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=96285

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Resolution|---                         |FIXED
             Status|ASSIGNED                    |RESOLVED

--- Comment #4 from Martin Liška <marxin at gcc dot gnu.org> ---
Fixed now.

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2020-08-27  7:49 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-22 13:25 [Bug c/96285] New: The documentation of -fprofile-exclude-files is unclear goeran at uddeborg dot se
2020-07-23  9:12 ` [Bug gcov-profile/96285] " marxin at gcc dot gnu.org
2020-07-23 12:58 ` marxin at gcc dot gnu.org
2020-07-24  8:31 ` goeran at uddeborg dot se
2020-08-26 23:07 ` cvs-commit at gcc dot gnu.org
2020-08-27  7:49 ` marxin at gcc dot gnu.org

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).