Skip to contentSkip to conversation

dev-manual: further gdb usage simplifications

PATCH Superseded [email protected] 2 participants 2 messages May 4, 2022 – May 5, 2022

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dev-manual: further gdb usage simplifications

From: Michael Opdenacker <[email protected]>

---
 documentation/dev-manual/common-tasks.rst | 17 +++++++----------
 1 file changed, 7 insertions(+), 10 deletions(-)
documentation/dev-manual/common-tasks.rst +7 -10
index c9fc585a05..8a2bfc3bb7 100644
@@ -10312,24 +10312,21 @@ debug on the target hardware.
 
 To support this kind of debugging, you need do the following:
 
--  Ensure that GDB is on the target. You can do this by adding "gdb" to
-   :term:`IMAGE_INSTALL`::
+-  Ensure that GDB is on the target. You can do this by making
+   the following addition to your ``local.conf`` file::
 
-      IMAGE_INSTALL:append = " gdb"
-
-   Alternatively, you can add "tools-debug" to :term:`IMAGE_FEATURES`::
-
-      IMAGE_FEATURES:append = " tools-debug"
+      EXTRA_IMAGE_FEATURES:append = " tools-debug"
 
 -  Ensure that debug symbols are present. You can make sure these
-   symbols are present by installing ``-dbg``::
+   symbols are present by adding the corresponding ``-dbg`` package
+   to :term:`IMAGE_INSTALL`::
 
       IMAGE_INSTALL:append = "packagename-dbg"
 
-   Alternatively, you can do the following to include
+   Alternatively, you can add the following to ``local.conf`` to include
    all the debug symbols::
 
-      IMAGE_FEATURES:append = " dbg-pkgs"
+      EXTRA_IMAGE_FEATURES:append = " dbg-pkgs"
 
 .. note::
 
Signature · 1 line
2.25.1
#1 lore raw

Hi Michael,

Quoted 20 lines · Michael Opdenacker via lists.yoctoproject.org

From: Michael Opdenacker <[email protected]>

---
  documentation/dev-manual/common-tasks.rst | 17 +++++++----------
  1 file changed, 7 insertions(+), 10 deletions(-)
documentation/dev-manual/common-tasks.rst +2 -2
index c9fc585a05..8a2bfc3bb7 100644
@@ -10312,24 +10312,21 @@ debug on the target hardware.
 
  To support this kind of debugging, you need do the following:
 
--  Ensure that GDB is on the target. You can do this by adding "gdb" to
-   :term:`IMAGE_INSTALL`::
+-  Ensure that GDB is on the target. You can do this by making
+   the following addition to your ``local.conf`` file::
 

documentation/dev-manual/common-tasks.rst debug on the target hardware. · line 10321

Quoted 10 lines
documentation/dev-manual/common-tasks.rst +2 -6
-      IMAGE_INSTALL:append = " gdb"
-
-   Alternatively, you can add "tools-debug" to :term:`IMAGE_FEATURES`::
-
-      IMAGE_FEATURES:append = " tools-debug"
+      EXTRA_IMAGE_FEATURES:append = " tools-debug"
 
  -  Ensure that debug symbols are present. You can make sure these
-   symbols are present by installing ``-dbg``::
+   symbols are present by adding the corresponding ``-dbg`` package

Maybe we can remove the repetition here?

"""
You can do so by adding the corresponding...
"""

or something like that?

documentation/dev-manual/common-tasks.rst debug on the target hardware. · line 10325

Quoted 4 lines
documentation/dev-manual/common-tasks.rst +1 -0
+   to :term:`IMAGE_INSTALL`::
 
        IMAGE_INSTALL:append = "packagename-dbg"
 

We are missing a leading space here.

Cheers,
Quentin