ref-manual: Updated the "Viewing Logs from Failed Tasks" section.

Fixes [YOCTO #10132]

Provided a better description and removed a deprecated sentence
near the end.

(From yocto-docs rev: bbe588e19bb9ed58883ae7c770da551de659e982)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 23 insertions, 10 deletions

diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index a7a63bd8cb..79322dd198 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -166,19 +166,32 @@
     <section id='usingpoky-debugging-viewing-logs-from-failed-tasks'>
         <title>Viewing Logs from Failed Tasks</title>
 
-        <para>The log file for shell tasks is available in
-            <filename>${WORKDIR}/temp/log.do_<replaceable>taskname</replaceable>.pid</filename>.
-            For example, the <filename>do_compile</filename> task for the QEMU minimal image for the x86
-            machine (<filename>qemux86</filename>) might be
-            <filename>tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile.20830</filename>.
-            To see what
-            <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>
-            runs to generate that log, look at the corresponding
-            <filename>run.do_<replaceable>taskname</replaceable>.pid</filename> file located in the same directory.
+        <para>
+            You can find the log for a task in the file
+            <filename>${WORKDIR}/temp/log.do_</filename><replaceable>taskname</replaceable><filename>.</filename><replaceable>pid</replaceable>.
+            For example, the log for the
+            <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>
+            task of the QEMU minimal image for the x86 machine
+            (<filename>qemux86</filename>) might be in
+            <filename>tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile.</filename><replaceable>pid</replaceable>.
+            To see the commands
+            <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink> ran
+            to generate a log, look at the corresponding
+            <filename>run.do_</filename><replaceable>taskname</replaceable><filename>.</filename><replaceable>pid</replaceable>
+            file in the same directory.
         </para>
 
         <para>
-            Presently, the output from Python tasks is sent directly to the console.
+            <filename>log.do_</filename><replaceable>taskname</replaceable> and
+            <filename>run.do_</filename><replaceable>taskname</replaceable>
+            are actually symbolic links to
+            <filename>log.do_</filename><replaceable>taskname</replaceable><filename>.</filename><replaceable>pid</replaceable>
+            and
+            <filename>log.run_</filename><replaceable>taskname</replaceable><filename>.</filename><replaceable>pid</replaceable>,
+            where <replaceable>pid</replaceable> is the PID the task had when
+            it ran.
+            The symlinks always point to the files corresponding to the most
+            recent run.
         </para>
     </section>