diff mbox

[8/8] Enhance documentation of gcov.

Message ID 6738b9023845d63ce1d1f9369c08a6f151d3766c.1493371589.git.mliska@suse.cz
State New
Headers show

Commit Message

Martin Liška April 27, 2017, 9:24 a.m. UTC
gcc/ChangeLog:

2017-04-27  Martin Liska  <mliska@suse.cz>

	* doc/gcov.texi: Enhance documentation of gcov.
---
 gcc/doc/gcov.texi | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Comments

Nathan Sidwell April 28, 2017, 11:26 a.m. UTC | #1
On 04/27/2017 05:24 AM, marxin wrote:
> gcc/ChangeLog:
> 
> 2017-04-27  Martin Liska  <mliska@suse.cz>
> 
> 	* doc/gcov.texi: Enhance documentation of gcov.


ok
Martin Sebor April 28, 2017, 11:32 p.m. UTC | #2
On 04/27/2017 03:24 AM, marxin wrote:
> gcc/ChangeLog:
>
> 2017-04-27  Martin Liska  <mliska@suse.cz>
>
> 	* doc/gcov.texi: Enhance documentation of gcov.
> ---
>  gcc/doc/gcov.texi | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/gcc/doc/gcov.texi b/gcc/doc/gcov.texi
> index 1befb5a3e08..c96f86df830 100644
> --- a/gcc/doc/gcov.texi
> +++ b/gcc/doc/gcov.texi
> @@ -324,7 +324,9 @@ command line option.  The @var{execution_count} is @samp{-} for lines
>  containing no code.  Unexecuted lines are marked @samp{#####} or
>  @samp{====}, depending on whether they are reachable by
>  non-exceptional paths or only exceptional paths such as C++ exception
> -handlers, respectively.
> +handlers, respectively. Given @samp{-a} option, unexecuted blocks are
> +marked @samp{$$$$$} or @samp{%%%%%}, depending whether a basic block
> +is reachable via non-exceptional or exceptional paths.

Since I started picking on this change set I might as well keep
at it ;)   Just a tiny nit: the sentence is missing a preposition:

   depending <ins>on </ins> whether a basic block is reachable.

Martin
Gerald Pfeifer July 22, 2018, 10:37 a.m. UTC | #3
On Fri, 28 Apr 2017, Martin Sebor wrote:
>> 2017-04-27  Martin Liska  <mliska@suse.cz>
>>
>> 	* doc/gcov.texi: Enhance documentation of gcov.
> Since I started picking on this change set I might as well keep
> at it ;)   Just a tiny nit: the sentence is missing a preposition:
> 
>   depending <ins>on </ins> whether a basic block is reachable.

This adds a bit more.  Applied.

(This section still needs a bit more love, ideally by a native
speaker.)

Gerald


2018-07-22  Gerald Pfeifer  <gerald@pfeifer.com>

	* doc/gcov.texi (Invoking Gcov): Editorial changes.

Index: doc/gcov.texi
===================================================================
--- doc/gcov.texi	(revision 262161)
+++ doc/gcov.texi	(working copy)
@@ -378,12 +378,12 @@
 containing no code.  Unexecuted lines are marked @samp{#####} or
 @samp{=====}, depending on whether they are reachable by
 non-exceptional paths or only exceptional paths such as C++ exception
-handlers, respectively. Given @samp{-a} option, unexecuted blocks are
+handlers, respectively. Given the @samp{-a} option, unexecuted blocks are
 marked @samp{$$$$$} or @samp{%%%%%}, depending on whether a basic block
 is reachable via non-exceptional or exceptional paths.
 Executed basic blocks having a statement with zero @var{execution_count}
-end with @samp{*} character and are colored with magenta color with @option{-k}
-option.  The functionality is not supported in Ada.
+end with @samp{*} character and are colored with magenta color with
+the @option{-k} option.  This functionality is not supported in Ada.
 
 Note that GCC can completely remove the bodies of functions that are
 not needed -- for instance if they are inlined everywhere.  Such functions
diff mbox

Patch

diff --git a/gcc/doc/gcov.texi b/gcc/doc/gcov.texi
index 1befb5a3e08..c96f86df830 100644
--- a/gcc/doc/gcov.texi
+++ b/gcc/doc/gcov.texi
@@ -324,7 +324,9 @@  command line option.  The @var{execution_count} is @samp{-} for lines
 containing no code.  Unexecuted lines are marked @samp{#####} or
 @samp{====}, depending on whether they are reachable by
 non-exceptional paths or only exceptional paths such as C++ exception
-handlers, respectively.
+handlers, respectively. Given @samp{-a} option, unexecuted blocks are
+marked @samp{$$$$$} or @samp{%%%%%}, depending whether a basic block
+is reachable via non-exceptional or exceptional paths.
 
 Some lines of information at the start have @var{line_number} of zero.
 These preamble lines are of the form
@@ -675,5 +677,5 @@  it.  This can be overcome by, for example, setting the environment as
 setting will name the data file @file{/target/run/build/foo.gcda}.
 
 You must move the data files to the expected directory tree in order to
-use them for profile directed optimizations (@option{--use-profile}), or to
+use them for profile directed optimizations (@option{-fprofile-use}), or to
 use the @command{gcov} tool.