From: Nicholas Nethercote Date: Thu, 30 Jul 2009 04:48:05 +0000 (+0000) Subject: Use for ms_print's and cg_annotate's options list. X-Git-Tag: svn/VALGRIND_3_5_0~185 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c6482fe1144b1a428e63110b0a5fd3f8e0a02187;p=thirdparty%2Fvalgrind.git Use for ms_print's and cg_annotate's options list. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10665 --- diff --git a/cachegrind/docs/cg-manual.xml b/cachegrind/docs/cg-manual.xml index 60a966b17a..4f4c37c05e 100644 --- a/cachegrind/docs/cg-manual.xml +++ b/cachegrind/docs/cg-manual.xml @@ -836,78 +836,109 @@ cg_annotate. cg_annotate options - + - - - - Help and version, as usual. - + + + + + + Show the help message. + + - - [default: - order in - cachegrind.out.<pid>] - Specifies the events upon which the sorting of the - function-by-function entries will be based. Useful if you - want to concentrate on eg. I cache misses - (), or D cache misses - (), or L2 misses - (). - + + + + + + Show the version number. + + - - [default: - all, using order in - cachegrind.out.<pid>] - Specifies which events to show (and the column - order). Default is to use all present in the - cachegrind.out.<pid> file (and - use the order in the file). - + + + + + + Specifies the events upon which the sorting of the + function-by-function entries will be based. Useful if you + want to concentrate on eg. I cache misses + (), or D cache misses + (), or L2 misses + (). + + - - - [default: 99%] - Sets the threshold for the function-by-function - summary. Functions are shown that account for more than X% - of the primary sort event. If auto-annotating, also affects - which files are annotated. - - Note: thresholds can be set for more than one of the - events by appending any events for the - option with a colon - and a number (no spaces, though). E.g. if you want to see - the functions that cover 99% of L2 read misses and 99% of L2 - write misses, use this option: - - + + + + + + Specifies which events to show (and the column + order). Default is to use all present in the + cachegrind.out.<pid> file (and + use the order in the file). + + - - [default] - - When enabled, automatically annotates every file that - is mentioned in the function-by-function summary that can be - found. Also gives a list of those that couldn't be found. - + + + + + + Sets the threshold for the function-by-function + summary. Functions are shown that account for more than X% + of the primary sort event. If auto-annotating, also affects + which files are annotated. + + Note: thresholds can be set for more than one of the + events by appending any events for the + option with a colon + and a number (no spaces, though). E.g. if you want to see + the functions that cover 99% of L2 read misses and 99% of L2 + write misses, use this option: + + + - - [default: 8] - Print N lines of context before and after each - annotated line. Avoids printing large sections of source - files that were not executed. Use a large number - (eg. 10,000) to show all source lines. - + + + + + + When enabled, automatically annotates every file that + is mentioned in the function-by-function summary that can be + found. Also gives a list of those that couldn't be found. + + - - - [default: empty string] - Adds a directory to the list in which to search for - files. Multiple -I/--include options can be given to add - multiple directories. - + + + + + + Print N lines of context before and after each + annotated line. Avoids printing large sections of source + files that were not executed. Use a large number + (eg. 10,000) to show all source lines. + + - + + +