dev-manual: further gdb usage simplifications

Message ID 20220504182400.702300-1-michael.opdenacker@bootlin.com
State New
Headers show
Series dev-manual: further gdb usage simplifications | expand

Commit Message

Michael Opdenacker May 4, 2022, 6:24 p.m. UTC
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/dev-manual/common-tasks.rst | 17 +++++++----------
 1 file changed, 7 insertions(+), 10 deletions(-)

Comments

Quentin Schulz May 5, 2022, 8:08 a.m. UTC | #1
Hi Michael,

On 5/4/22 20:24, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>   documentation/dev-manual/common-tasks.rst | 17 +++++++----------
>   1 file changed, 7 insertions(+), 10 deletions(-)
> 
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index c9fc585a05..8a2bfc3bb7 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -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

Maybe we can remove the repetition here?

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

or something like that?

> +   to :term:`IMAGE_INSTALL`::
>   
>         IMAGE_INSTALL:append = "packagename-dbg"
>   

We are missing a leading space here.

Cheers,
Quentin

Patch

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index c9fc585a05..8a2bfc3bb7 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -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::