commit a02e2677ab02bcded6111d74320d4c1f4f062798 Author: philippe Date: Wed Mar 6 22:39:18 2013 +0000 Fix 316144 (valgrind.1 manpage contains ??? strings for references) Patch by Mark Wielaard. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@13314 a5019735-40e9-0310-863c-91ae7b9d1cf9 diff --git a/docs/xml/manual-core-adv.xml b/docs/xml/manual-core-adv.xml index 2a022a0..00376a1 100644 --- a/docs/xml/manual-core-adv.xml +++ b/docs/xml/manual-core-adv.xml @@ -293,9 +293,9 @@ tool-specific macros). - - + + Debugging your program using Valgrind gdbserver and GDB A program running under Valgrind is not executed directly by the @@ -381,7 +381,7 @@ and gives the results back to GDB. GDB can use various kinds of channels (TCP/IP, serial line, etc) to communicate with the gdbserver. In the case of Valgrind's gdbserver, communication is done via a pipe and a small helper program -called , which acts as an +called , which acts as an intermediary. If no GDB is in use, vgdb can also be used to send monitor commands to the Valgrind gdbserver from a shell command line. @@ -1105,8 +1105,9 @@ $5 = 36 - + + vgdb command line options Usage: vgdb [OPTION]... [[-c] COMMAND]... @@ -1254,8 +1255,9 @@ vgdb v.set log_output -c leak_check any - + + Valgrind monitor commands This section describes the Valgrind monitor commands, available diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml index 70b0989..a60c3a4 100644 --- a/docs/xml/manual-core.xml +++ b/docs/xml/manual-core.xml @@ -152,7 +152,8 @@ likely. - + + The Commentary Valgrind tools write a commentary, a stream of text, detailing @@ -857,7 +858,7 @@ in most cases. We group the available options by rough categories. be used in conjunction with the valgrind-listener program. For further details, see - the commentary + the commentary in the manual. @@ -1755,7 +1756,7 @@ need to use them. between fairness and performance. For more details about the Valgrind thread serialisation scheme and its impact on performance and thread scheduling, see - . + . The value @@ -2084,7 +2085,8 @@ everything is shared (a thread) or nothing is shared (fork-like); partial sharing will fail. - + + Scheduling and Multi-Thread Performance A thread executes code only when it holds the abovementioned diff --git a/docs/xml/valgrind-manpage.xml b/docs/xml/valgrind-manpage.xml index 8f2f630..bd4b924 100644 --- a/docs/xml/valgrind-manpage.xml +++ b/docs/xml/valgrind-manpage.xml @@ -240,7 +240,22 @@ callgrind_annotate(1), callgrind_control(1), ms_print(1), &vg-docs-path; or -&vg-docs-url;. +&vg-docs-url;, +&vg-gdbserver-label; +&vg-vgdb-label;, +&vg-monitor-label;, +&vg-comment-label;, +&vg-pthreads-perf-sched-label;. diff --git a/docs/xml/vg-entities.xml b/docs/xml/vg-entities.xml index e65ed3e..f5994c1 100644 --- a/docs/xml/vg-entities.xml +++ b/docs/xml/vg-entities.xml @@ -23,4 +23,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + commit 90285ba7ed34f3fdef235d2976399bcd360d4515 Author: philippe Date: Sun Mar 10 16:20:10 2013 +0000 fix 315959 valgrind man page has bogus SGCHECK (and no BBV) OPTIONS section PAtch from Mark Wielaard. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@13323 a5019735-40e9-0310-863c-91ae7b9d1cf9 diff --git a/exp-sgcheck/docs/sg-manual.xml b/exp-sgcheck/docs/sg-manual.xml index 8632199..8b717e8 100644 --- a/exp-sgcheck/docs/sg-manual.xml +++ b/exp-sgcheck/docs/sg-manual.xml @@ -31,7 +31,7 @@ observation about the likely forms of stack and global array accesses. SGCheck Command-line Options -There are no SGCheck-specific command-line options at present. +There are no SGCheck-specific command-line options at present. + Cachegrind: a cache and branch-prediction profiler To use this tool, you must specify diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index ab8d9bb..2f08ac8 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -88,7 +88,7 @@ optimization opportunities depend on changing code in the callers, in particular by reducing the call count. Callgrind's cache simulation is based on that of Cachegrind. -Read the documentation for first. The material +Read the documentation for first. The material below describes the features supported in addition to Cachegrind's features. @@ -936,7 +936,7 @@ Also see . Cache misses on instruction reads ("I1mr"/"ILmr"), data read accesses ("Dr") and related cache misses ("D1mr"/"DLmr"), data write accesses ("Dw") and related cache misses ("D1mw"/"DLmw"). - For more information, see . + For more information, see . diff --git a/docs/xml/valgrind-manpage.xml b/docs/xml/valgrind-manpage.xml index bd4b924..a4b84ff 100644 --- a/docs/xml/valgrind-manpage.xml +++ b/docs/xml/valgrind-manpage.xml @@ -255,7 +255,10 @@ ms_print(1), url="&vg-comment-url;">&vg-comment-label;, &vg-pthreads-perf-sched-label;. + url="&vg-pthreads-perf-sched-url;">&vg-pthreads-perf-sched-label;, +&vg-cg-manual-label;. diff --git a/docs/xml/vg-entities.xml b/docs/xml/vg-entities.xml index f5994c1..29a337f 100644 --- a/docs/xml/vg-entities.xml +++ b/docs/xml/vg-entities.xml @@ -58,3 +58,7 @@ + + + + diff -ur valgrind-3.8.1.orig/docs/callgrind_annotate.1 valgrind-3.8.1/docs/callgrind_annotate.1 --- valgrind-3.8.1.orig/docs/callgrind_annotate.1 2013-03-12 14:42:11.627471322 +0100 +++ valgrind-3.8.1/docs/callgrind_annotate.1 2013-03-12 14:42:28.762370486 +0100 @@ -1,13 +1,13 @@ '\" t .\" Title: Callgrind Annotate .\" Author: [see the "Author" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 09/18/2012 +.\" Generator: DocBook XSL Stylesheets v1.77.1 +.\" Date: 03/12/2013 .\" Manual: Release 3.8.0 .\" Source: Release 3.8.0 .\" Language: English .\" -.TH "CALLGRIND ANNOTATE" "1" "09/18/2012" "Release 3.8.0" "Release 3.8.0" +.TH "CALLGRIND ANNOTATE" "1" "03/12/2013" "Release 3.8.1" "Release 3.8.1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff -ur valgrind-3.8.1.orig/docs/callgrind_control.1 valgrind-3.8.1/docs/callgrind_control.1 --- valgrind-3.8.1.orig/docs/callgrind_control.1 2013-03-12 14:42:11.630471305 +0100 +++ valgrind-3.8.1/docs/callgrind_control.1 2013-03-12 14:42:28.778370392 +0100 @@ -1,13 +1,13 @@ '\" t .\" Title: Callgrind Control .\" Author: [see the "Author" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 09/18/2012 +.\" Generator: DocBook XSL Stylesheets v1.77.1 +.\" Date: 03/12/2013 .\" Manual: Release 3.8.0 .\" Source: Release 3.8.0 .\" Language: English .\" -.TH "CALLGRIND CONTROL" "1" "09/18/2012" "Release 3.8.0" "Release 3.8.0" +.TH "CALLGRIND CONTROL" "1" "03/12/2013" "Release 3.8.1" "Release 3.8.1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff -ur valgrind-3.8.1.orig/docs/cg_annotate.1 valgrind-3.8.1/docs/cg_annotate.1 --- valgrind-3.8.1.orig/docs/cg_annotate.1 2013-03-12 14:42:11.627471322 +0100 +++ valgrind-3.8.1/docs/cg_annotate.1 2013-03-12 14:42:28.745370586 +0100 @@ -1,13 +1,13 @@ '\" t .\" Title: cg_annotate .\" Author: [see the "Author" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 09/18/2012 +.\" Generator: DocBook XSL Stylesheets v1.77.1 +.\" Date: 03/12/2013 .\" Manual: Release 3.8.0 .\" Source: Release 3.8.0 .\" Language: English .\" -.TH "CG_ANNOTATE" "1" "09/18/2012" "Release 3.8.0" "Release 3.8.0" +.TH "CG_ANNOTATE" "1" "03/12/2013" "Release 3.8.1" "Release 3.8.1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff -ur valgrind-3.8.1.orig/docs/ms_print.1 valgrind-3.8.1/docs/ms_print.1 --- valgrind-3.8.1.orig/docs/ms_print.1 2013-03-12 14:42:11.627471322 +0100 +++ valgrind-3.8.1/docs/ms_print.1 2013-03-12 14:42:28.793370304 +0100 @@ -1,13 +1,13 @@ '\" t .\" Title: ms_print .\" Author: [see the "Author" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 09/18/2012 +.\" Generator: DocBook XSL Stylesheets v1.77.1 +.\" Date: 03/12/2013 .\" Manual: Release 3.8.0 .\" Source: Release 3.8.0 .\" Language: English .\" -.TH "MS_PRINT" "1" "09/18/2012" "Release 3.8.0" "Release 3.8.0" +.TH "MS_PRINT" "1" "03/12/2013" "Release 3.8.1" "Release 3.8.1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff -ur valgrind-3.8.1.orig/docs/valgrind.1 valgrind-3.8.1/docs/valgrind.1 --- valgrind-3.8.1.orig/docs/valgrind.1 2013-03-12 14:42:11.626471328 +0100 +++ valgrind-3.8.1/docs/valgrind.1 2013-03-12 14:42:28.728370686 +0100 @@ -1,13 +1,13 @@ '\" t .\" Title: VALGRIND .\" Author: [see the "Author" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 09/18/2012 +.\" Generator: DocBook XSL Stylesheets v1.77.1 +.\" Date: 03/12/2013 .\" Manual: Release 3.8.0 .\" Source: Release 3.8.0 .\" Language: English .\" -.TH "VALGRIND" "1" "09/18/2012" "Release 3.8.0" "Release 3.8.0" +.TH "VALGRIND" "1" "03/12/2013" "Release 3.8.1" "Release 3.8.1" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -134,13 +134,13 @@ is specified\&. This allows an external GNU GDB debugger to control and debug your program when it runs on Valgrind\&. \fB\-\-vgdb=full\fR incurs significant performance overheads, but provides more precise breakpoints and watchpoints\&. See -??? +Debugging your program using Valgrind's gdbserver and GDB for a detailed description\&. .sp If the embedded gdbserver is enabled but no gdb is currently being used, the -??? +vgdb command line utility can send "monitor commands" to Valgrind from a shell\&. The Valgrind core provides a set of -???\&. A tool can optionally provide tool specific monitor commands, which are documented in the tool specific chapter\&. +Valgrind monitor commands\&. A tool can optionally provide tool specific monitor commands, which are documented in the tool specific chapter\&. .RE .PP \fB\-\-vgdb\-error= [default: 999999999] \fR @@ -300,6 +300,15 @@ Specifies an alternative exit code to return if Valgrind reported any errors in the run\&. When set to the default value (zero), the return value from Valgrind will always be the return value of the process being simulated\&. When set to a nonzero value, that value is returned instead, if Valgrind detects any errors\&. This is useful for using Valgrind as part of an automated test suite, since it makes it easy to detect test cases for which Valgrind has reported errors, just by inspecting return codes\&. .RE .PP +\fB\-\-sigill\-diagnostics= [default: yes] \fR +.RS 4 +Enable/disable printing of illegal instruction diagnostics\&. Enabled by default, but defaults to disabled when +\fB\-\-quiet\fR +is given\&. The default can always be explicitly overridden by giving this option\&. +.sp +When enabled a warning message will be printed with some diagnostics whenever some instruction is encountered that valgrind cannot decode or translate before the program is given a SIGILL signal\&. Often an illegal instruction indicates a bug in the program or missing support for the particular instruction in Valgrind\&. But some programs do deliberately try to execute an instruction that might be missing and trap the SIGILL signal to detect processor features\&. +.RE +.PP \fB\-\-show\-below\-main= [default: no] \fR .RS 4 By default, stack traces for errors do not show any functions that appear beneath @@ -755,7 +764,7 @@ The \fB\-\-fair\-sched\fR option controls the locking mechanism used by Valgrind to serialise thread execution\&. The locking mechanism controls the way the threads are scheduled, and different settings give different trade\-offs between fairness and performance\&. For more details about the Valgrind thread serialisation scheme and its impact on performance and thread scheduling, see -???\&. +Scheduling and Multi-Thread Performance\&. .sp .RS 4 .ie n \{\ @@ -1242,7 +1251,7 @@ \fB\-\-cache\-sim= [default: no] \fR .RS 4 Specify if you want to do full cache simulation\&. By default, only instruction read accesses will be counted ("Ir")\&. With cache simulation, further event counters are enabled: Cache misses on instruction reads ("I1mr"/"ILmr"), data read accesses ("Dr") and related cache misses ("D1mr"/"DLmr"), data write accesses ("Dw") and related cache misses ("D1mw"/"DLmw")\&. For more information, see -???\&. +Cachegrind: a cache and branch-prediction profiler\&. .RE .PP \fB\-\-branch\-sim= [default: no] \fR @@ -1568,7 +1577,9 @@ \fB--log-file\fR\&. .RE .SH "SGCHECK OPTIONS" -.SH "BBV OPTIONS" +.PP +There are no SGCheck\-specific command\-line options at present\&. +.SH "BBV OPTIONS" .PP \fB\-\-bb\-out\-file= [default: bb\&.out\&.%p] \fR .RS 4 @@ -1705,9 +1716,46 @@ cg_annotate(1), callgrind_annotate(1), callgrind_control(1), ms_print(1), $INSTALL/share/doc/valgrind/html/index\&.html or -http://www\&.valgrind\&.org/docs/manual/index\&.html\&. +http://www\&.valgrind\&.org/docs/manual/index\&.html, +\m[blue]\fBDebugging your program using Valgrind\*(Aqs gdbserver and GDB\fR\m[]\&\s-2\u[1]\d\s+2 +\m[blue]\fBvgdb\fR\m[]\&\s-2\u[2]\d\s+2, +\m[blue]\fBValgrind monitor commands\fR\m[]\&\s-2\u[3]\d\s+2, +\m[blue]\fBThe Commentary\fR\m[]\&\s-2\u[4]\d\s+2, +\m[blue]\fBScheduling and Multi\-Thread Performance\fR\m[]\&\s-2\u[5]\d\s+2, +\m[blue]\fBCachegrind: a cache and branch\-prediction profiler\fR\m[]\&\s-2\u[6]\d\s+2\&. .SH "AUTHOR" .PP The Valgrind developers\&. .PP This manpage was written by Andres Roldan and the Valgrind developers\&. +.SH "NOTES" +.IP " 1." 4 +Debugging your program using Valgrind's gdbserver and GDB +.RS 4 +\%http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.gdbserver +.RE +.IP " 2." 4 +vgdb +.RS 4 +\%http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.vgdb +.RE +.IP " 3." 4 +Valgrind monitor commands +.RS 4 +\%http://www.valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.valgrind-monitor-commands +.RE +.IP " 4." 4 +The Commentary +.RS 4 +\%http://www.valgrind.org/docs/manual/manual-core.html#manual-core.comment +.RE +.IP " 5." 4 +Scheduling and Multi-Thread Performance +.RS 4 +\%http://www.valgrind.org/docs/manual/manual-core.html#manual-core.pthreads_perf_sched +.RE +.IP " 6." 4 +Cachegrind: a cache and branch-prediction profiler +.RS 4 +\%http://www.valgrind.org/docs/manual/cg-manual.html +.RE