Update documentation about --show-below-main.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5189

diff --git a/docs/valgrind.1 b/docs/valgrind.1
index a02c471cb384dfa0b2ddd69d410a9a157429b631..beb47717bf31b56b2632f2d82f5f7b354c7bd6dd 100644 (file)
--- a/docs/valgrind.1
+++ b/docs/valgrind.1
@@ -269,9 +269,11 @@ regression tests or have some other automated test machinery.
 .B
 --show-below-main=<yes|no> [default: no]
 When enabled, this option causes full stack backtraces to be emited,
-including the part before \fBmain\fP in your program (subject to the
-\fB--num-callers\fP option.)  When disabled, only the part of the stack
-backtrace up to and including main is printed.
+including the part before \fBmain\fP (or similar functions such as glibc's
+\fB__libc_start_main\fP, if \fBmain\fP is not present in the stack trace) in
+your program (subject to the \fB--num-callers\fP option.)  When disabled,
+only the part of the stack backtrace up to and including \fBmain\fP is
+printed.
 
 .TP
 .B

diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml
index a493240efd0ccc4e2332797717bb590aa7a10121..83dbd9a1f8313864bc29631817091a3cf56e9e99 100644 (file)
--- a/docs/xml/manual-core.xml
+++ b/docs/xml/manual-core.xml
@@ -808,9 +808,11 @@ errors, e.g. Memcheck, but not Cachegrind.</para>
     [default]</para>
     <para>By default, stack traces for errors do not show any
     functions that appear beneath
-    <computeroutput>main()</computeroutput>; most of the time
-    it's uninteresting C library stuff.  If this option is
-    enabled, these entries below
+    <computeroutput>main()</computeroutput> (or similar functions
+    such as glibc's <computeroutput>__libc_start_main()</computeroutput>, if
+    <computeroutput>main()</computeroutput> is not present in the stack
+    trace); most of the time it's uninteresting C library stuff.  If this
+    option is enabled, these entries below
     <computeroutput>main()</computeroutput> will be shown.</para>
    </listitem>