From: Ivo Raisr <ivosh@ivosh.net>
Date: Wed, 25 Jan 2017 07:22:18 +0000 (+0000)
Subject: Document limitation of --log-file when a program forks.
X-Git-Tag: svn/VALGRIND_3_13_0~211
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5216c18012c487b8ec24be866acb4e9f9fc90870;p=thirdparty%2Fvalgrind.git

Document limitation of --log-file when a program forks.
Follow up to r16200 and BZ#162848.


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

diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml
index 94885d0729..627b7e3db2 100644
--- a/docs/xml/manual-core.xml
+++ b/docs/xml/manual-core.xml
@@ -886,7 +886,11 @@ in most cases.  We group the available options by rough categories.</para>
       calling exec afterwards, and you don't use this specifier
       (or the <option>%q</option> specifier below), the Valgrind output from
       all those processes will go into one file, possibly jumbled up, and
-      possibly incomplete.</para>
+      possibly incomplete. Note: If the program forks and calls exec afterwards,
+      Valgrind output of the child from the period between fork and exec
+      will be lost. Fortunately this gap is really tiny for most programs;
+      and modern programs use <computeroutput>posix_spawn</computeroutput>
+      anyway.</para>
 
       <para><option>%n</option> is replaced with a file sequence number
       unique for this process.
@@ -912,7 +916,7 @@ in most cases.  We group the available options by rough categories.</para>
       causes an abort.</para>
 
       <para>If the file name specifies a relative file name, it is put
-      in the program's initial working directory : this is the current
+      in the program's initial working directory: this is the current
       directory when the program started its execution after the fork
       or after the exec.  If it specifies an absolute file name (ie.
       starts with '/') then it is put there.