From: Scott Rifenbark <srifenbark@gmail.com>
Date: Mon, 18 Jul 2016 17:21:06 +0000 (-0700)
Subject: ref-manual: Applied review comments to logging mechanism section
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=818e439cf5d23a3b0a2b89cd79acfa97929d983b;p=thirdparty%2Fopenembedded%2Fopenembedded-core-contrib.git

ref-manual: Applied review comments to logging mechanism section

Fixes [YOCTO #9950]

I Provided a suggested introductory sentence and a better link to
the logging.class file, which is near the end.

(From yocto-docs rev: 6f296266b35f17792510d6a01f5640ba30818a22)

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

diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index f94e3a79ffb..40e39b55785 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -356,8 +356,8 @@
     <section id='recipe-logging-mechanisms'>
         <title>Recipe Logging Mechanisms</title>
         <para>
-            Best practices exist while writing recipes that both log build
-            progress and act on build conditions such as warnings and errors.
+            The Yocto Project provides several logging functions for producing
+            debugging output and reporting errors and warnings.
             For Python functions, the following logging functions exist.
             All of these functions log to
             <filename>${T}/log.do_</filename><replaceable>task</replaceable>,
@@ -411,13 +411,13 @@
             <filename>bbplain</filename>, <filename>bbnote</filename>,
             <filename>bbdebug</filename>, <filename>bbwarn</filename>,
             <filename>bberror</filename>, and <filename>bbfatal</filename>.
-        </para>
-
-        <para>
-            For guidance on how logging is handled in both Python and Bash recipes, see the
-            <filename>logging.bbclass</filename> file in the
+            The
+            <link linkend='ref-classes-logging'><filename>logging</filename></link>
+            class implements these functions.
+            See that class in the
             <filename>meta/classes</filename> folder of the
-            <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
+            <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
+            for information.
         </para>
 
         <section id='logging-with-python'>