From 669ec46d93c526ed19872ca7fe260a1053cf868a Mon Sep 17 00:00:00 2001 From: Nicholas Nethercote Date: Thu, 30 Jul 2009 04:22:09 +0000 Subject: [PATCH] Remove lots of boilerplate text (tool descriptions) that tends to get out of date from the man page. Make the man page match the ordering in the user manual. Put Nulgrind last in the user manual. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10662 --- docs/xml/manual.xml | 4 +- docs/xml/valgrind-manpage.xml | 115 +++++++++------------------------- 2 files changed, 31 insertions(+), 88 deletions(-) diff --git a/docs/xml/manual.xml b/docs/xml/manual.xml index d6a89351a8..8694aacd8b 100644 --- a/docs/xml/manual.xml +++ b/docs/xml/manual.xml @@ -40,9 +40,9 @@ xmlns:xi="http://www.w3.org/2001/XInclude" /> - + diff --git a/docs/xml/valgrind-manpage.xml b/docs/xml/valgrind-manpage.xml index 7163eecdf7..0068bfeb84 100644 --- a/docs/xml/valgrind-manpage.xml +++ b/docs/xml/valgrind-manpage.xml @@ -20,14 +20,9 @@ valgrind - - valgrind - options - - your-program - - your-program-options - + valgrind-options + your-program + your-program-options @@ -37,10 +32,13 @@ Valgrind is a flexible program for debugging and profiling Linux executables. It consists of a core, which provides -a synthetic CPU in software, and a series of "tools", each of which is a -debugging or profiling tool. The architecture is modular, so that new -tools can be created easily and without disturbing the existing -structure. +a synthetic CPU in software, and a series of debugging and profiling tools. +The architecture is modular, so that new tools can be created easily and +without disturbing the existing structure. + +Some of the options described below work with all Valgrind tools, and +some only work with a few or one. The section MEMCHECK OPTIONS and those +below it describe tool-specific options. This manual page covers only basic usage and options. For more comprehensive information, please see the HTML documentation on your @@ -50,72 +48,6 @@ system: &vg-doc-path;, or online: - -Invocation - -Valgrind is typically invoked as follows: - valgrind program args - -This runs program (with arguments -args) under Valgrind using the Memcheck tool. -Memcheck performs a range of memory-checking functions, including -detecting accesses to uninitialised memory, misuse of allocated memory -(double frees, access after free, etc.) and detecting memory -leaks. - -To use a different tool, use the option: - valgrind --tool=toolname program args - -The following tools are available: - - - - - is a cache simulator. It can be - used to annotate every line of your program with the number of - instructions executed and cache misses incurred. - - - - adds call graph tracing to cachegrind. It can be - used to get call counts and inclusive cost for each call happening in your - program. In addition to cachegrind, callgrind can annotate threads separately, - and every instruction of disassembler output of your program with the number of - instructions executed and cache misses incurred. - - - - spots potential race conditions in - your program. - - - - is a sample tool that can be used as a - template for generating your own tools. After the program - terminates, it prints out some basic statistics about the program - execution. - - - - is a heap profiler. It measures how - much heap memory your program uses. - - - - is a fine-grained memory checker. - - - - performs no function - it simply runs - the program under Valgrind. This is typically used for debugging - and benchmarking Valgrind. - - - - - - - Basic Options @@ -228,22 +160,33 @@ leaks. - -Massif Options + +Helgrind Options - - -Helgrind Options + +DRD Options - + + + + + + +Massif Options + + -- 2.47.3