dev-manual: Updates to the on-target debugging section.

Fixes [YOCTO #9554]

I applied some review comments for the section on using GDB
on the target for debugging.  Included a new note on optimizations
considerations.

(From yocto-docs rev: 23f0dd82f682ea39849de0f589ee1ebfb16be749)

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

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index b20d9c32f3377513dab9295e19a4638256559e52..4cdd805cec5713aa8bd32a53645e380dbad6c890 100644 (file)
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -9875,7 +9875,10 @@
 
         <para>
             The previous section addressed using GDB remotely for debugging
-            purposes.
+            purposes, which is the most usual case due to the inherent
+            hardware limitations on many embedded devices.
+            However, debugging in the target hardware itself is also possible
+            with the most powerful devices.
             This section describes what you need to do in order to support
             using GDB to debug on the target hardware.
         </para>
@@ -9910,6 +9913,22 @@
                     </literallayout>
                     </para></listitem>
             </itemizedlist>
+            <note>
+                To improve the debug information accuracy, you can reduce the
+                level of optimization used by the compiler.
+                For example, when adding the following line to your
+                <filename>local.conf</filename> file, you will reduce
+                optimization from
+                <ulink url='&YOCTO_DOCS_REF_URL;#var-FULL_OPTIMIZATION'><filename>FULL_OPTIMIZATION</filename></ulink>
+                of "-O2" to
+                <ulink url='&YOCTO_DOCS_REF_URL;#var-DEBUG_OPTIMIZATION'><filename>DEBUG_OPTIMIZATION</filename></ulink>
+                of "-O -fno-omit-frame-pointer":
+                <literallayout class='monospaced'>
+     DEBUG_BUILD = "1"
+                </literallayout>
+                Consider that this will reduce the application's performance
+                and is recommended only for debugging purposes.
+            </note>
         </para>
     </section>