From f2c3b420171091bb377137ae3af9ed1cbc173298 Mon Sep 17 00:00:00 2001 From: Martin Liska Date: Tue, 21 Mar 2017 15:41:11 +0100 Subject: [PATCH] Document gcov-dump and fix installation of gcov-tool (PR gcov-profile/80081). 2017-03-21 Martin Liska PR gcov-profile/80081 * Makefile.in: Add gcov-dump and fix installation of gcov-tool. * doc/gcc.texi: Include gcov-dump stuff. * doc/gcov-dump.texi: New file. From-SVN: r246321 --- gcc/ChangeLog | 7 ++++ gcc/Makefile.in | 11 ++++- gcc/doc/gcc.texi | 3 ++ gcc/doc/gcov-dump.texi | 93 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 112 insertions(+), 2 deletions(-) create mode 100644 gcc/doc/gcov-dump.texi diff --git a/gcc/ChangeLog b/gcc/ChangeLog index ff2cd7a15bc..a7a13f1049a 100644 --- a/gcc/ChangeLog +++ b/gcc/ChangeLog @@ -1,3 +1,10 @@ +2017-03-21 Martin Liska + + PR gcov-profile/80081 + * Makefile.in: Add gcov-dump and fix installation of gcov-tool. + * doc/gcc.texi: Include gcov-dump stuff. + * doc/gcov-dump.texi: New file. + 2017-03-21 Toma Tabacu PR rtl-optimization/79150 diff --git a/gcc/Makefile.in b/gcc/Makefile.in index e54fac4ec1c..50d84bfdc46 100644 --- a/gcc/Makefile.in +++ b/gcc/Makefile.in @@ -3082,7 +3082,7 @@ TEXI_GCC_FILES = gcc.texi gcc-common.texi gcc-vers.texi frontends.texi \ gcov.texi trouble.texi bugreport.texi service.texi \ contribute.texi compat.texi funding.texi gnu.texi gpl_v3.texi \ fdl.texi contrib.texi cppenv.texi cppopts.texi avr-mmcu.texi \ - implement-c.texi implement-cxx.texi gcov-tool.texi + implement-c.texi implement-cxx.texi gcov-tool.texi gcov-dump.texi # we explicitly use $(srcdir)/doc/tm.texi here to avoid confusion with # the generated tm.texi; the latter might have a more recent timestamp, @@ -3205,7 +3205,7 @@ $(build_htmldir)/gccinstall/index.html: $(TEXI_GCCINSTALL_FILES) $(SHELL) $(srcdir)/doc/install.texi2html MANFILES = doc/gcov.1 doc/cpp.1 doc/gcc.1 doc/gfdl.7 doc/gpl.7 \ - doc/fsf-funding.7 doc/gcov-tool.1 + doc/fsf-funding.7 doc/gcov-tool.1 doc/gcov-dump.1 generated-manpages: man @@ -3613,6 +3613,8 @@ install-man: lang.install-man \ $(DESTDIR)$(man1dir)/$(GCC_INSTALL_NAME)$(man1ext) \ $(DESTDIR)$(man1dir)/$(CPP_INSTALL_NAME)$(man1ext) \ $(DESTDIR)$(man1dir)/$(GCOV_INSTALL_NAME)$(man1ext) \ + $(DESTDIR)$(man1dir)/$(GCOV_TOOL_INSTALL_NAME)$(man1ext) \ + $(DESTDIR)$(man1dir)/$(GCOV_DUMP_INSTALL_NAME)$(man1ext) \ $(DESTDIR)$(man7dir)/fsf-funding$(man7ext) \ $(DESTDIR)$(man7dir)/gfdl$(man7ext) \ $(DESTDIR)$(man7dir)/gpl$(man7ext) @@ -3642,6 +3644,11 @@ $(DESTDIR)$(man1dir)/$(GCOV_TOOL_INSTALL_NAME)$(man1ext): doc/gcov-tool.1 instal -$(INSTALL_DATA) $< $@ -chmod a-x $@ +$(DESTDIR)$(man1dir)/$(GCOV_DUMP_INSTALL_NAME)$(man1ext): doc/gcov-dump.1 installdirs + -rm -f $@ + -$(INSTALL_DATA) $< $@ + -chmod a-x $@ + # Install all the header files built in the include subdirectory. install-headers: $(INSTALL_HEADERS_DIR) # Fix symlinks to absolute paths in the installed include directory to diff --git a/gcc/doc/gcc.texi b/gcc/doc/gcc.texi index c97528803fe..87df83f0131 100644 --- a/gcc/doc/gcc.texi +++ b/gcc/doc/gcc.texi @@ -67,6 +67,7 @@ Texts being (a) (see below), and with the Back-Cover Texts being (b) * g++: (gcc). The GNU C++ compiler. * gcov: (gcc) Gcov. @command{gcov}---a test coverage program. * gcov-tool: (gcc) Gcov-tool. @command{gcov-tool}---an offline gcda profile processing program. +* gcov-dump: (gcc) Gcov-dump. @command{gcov-dump}---an offline gcda and gcno profile dump tool. @end direntry This file documents the use of the GNU compilers. @sp 1 @@ -140,6 +141,7 @@ Introduction, gccint, GNU Compiler Collection (GCC) Internals}. * Compatibility:: Binary Compatibility * Gcov:: @command{gcov}---a test coverage program. * Gcov-tool:: @command{gcov-tool}---an offline gcda profile processing program. +* Gcov-dump:: @command{gcov-dump}---an offline gcda and gcno profile dump tool. * Trouble:: If you have trouble using GCC. * Bugs:: How, why and where to report bugs. * Service:: How To Get Help with GCC @@ -167,6 +169,7 @@ Introduction, gccint, GNU Compiler Collection (GCC) Internals}. @include compat.texi @include gcov.texi @include gcov-tool.texi +@include gcov-dump.texi @include trouble.texi @include bugreport.texi @include service.texi diff --git a/gcc/doc/gcov-dump.texi b/gcc/doc/gcov-dump.texi new file mode 100644 index 00000000000..d7931fd3a19 --- /dev/null +++ b/gcc/doc/gcov-dump.texi @@ -0,0 +1,93 @@ +@c Copyright (C) 2017 Free Software Foundation, Inc. +@c This is part of the GCC manual. +@c For copying conditions, see the file gcc.texi. + +@ignore +@c man begin COPYRIGHT +Copyright @copyright{} 2017 Free Software Foundation, Inc. + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with the +Invariant Sections being ``GNU General Public License'' and ``Funding +Free Software'', the Front-Cover texts being (a) (see below), and with +the Back-Cover Texts being (b) (see below). A copy of the license is +included in the gfdl(7) man page. + +(a) The FSF's Front-Cover Text is: + + A GNU Manual + +(b) The FSF's Back-Cover Text is: + + You have freedom to copy and modify this GNU Manual, like GNU + software. Copies published by the Free Software Foundation raise + funds for GNU development. +@c man end +@c Set file name and title for the man page. +@setfilename gcov-dump +@settitle offline gcda and gcno profile dump tool +@end ignore + +@node Gcov-dump +@chapter @command{gcov-dump}---an Offline Gcda and Gcno Profile Dump Tool + +@menu +* Gcov-dump Intro:: Introduction to gcov-dump. +* Invoking Gcov-dump:: How to use gcov-dump. +@end menu + +@node Gcov-dump Intro +@section Introduction to @command{gcov-dump} +@c man begin DESCRIPTION + +@command{gcov-dump} is a tool you can use in conjunction with GCC to +dump content of gcda and gcno profile files offline. + +@c man end + +@node Invoking Gcov-dump +@section Invoking @command{gcov-dump} + +@smallexample +Usage: gcov-dump @r{[}@var{OPTION}@r{]} ... @var{gcovfiles} +@end smallexample + +@command{gcov-dump} accepts the following options: + +@ignore +@c man begin SYNOPSIS +gcov-dump [@option{-v}|@option{--version}] + [@option{-h}|@option{--help}] + [@option{-l}|@option{--long}] + [@option{-p}|@option{--positions}] + [@option{-w}|@option{--working-sets}] @var{gcovfiles} +@c man end +@end ignore + +@c man begin OPTIONS +@table @gcctabopt +@item -h +@itemx --help +Display help about using @command{gcov-dump} (on the standard output), and +exit without doing any further processing. + +@item -v +@itemx --version +Display the @command{gcov-dump} version number (on the standard output), +and exit without doing any further processing. + +@item -l +@itemx --long +Dump content of records. + +@item -p +@itemx --positions +Dump positions of records. + +@item -w +@itemx --working-sets +Dump working set computed from summary. +@end table + +@c man end -- 2.30.2