Re: [docs] [PATCH] dev-manual/debugging: improve gdbserver debugfs docs

["Antonin Godard" <antonin.godard@bootlin.com>]

Hi Adrian,

On Mon Oct 21, 2024 at 9:54 PM CEST, Adrian Freihofer wrote:
> Chris Laplante via lists.yoctoproject.org <chris.laplante=
> agilent.com@lists.yoctoproject.org> schrieb am Mo., 21. Okt. 2024, 17:23:
>
>> From: Chris Laplante <chris.laplante@agilent.com>
>>
>> 1. Make it clear that IMAGE_FSTYPES has to contain tar.bz2
>> 2. Fix the 'cp -a packages-split/bash-dbg/* path/debugfs' step to not
>>    literally try to copy a file called '*'
>>
>> Signed-off-by: Chris Laplante <chris.laplante@agilent.com>
>> ---
>>  documentation/dev-manual/debugging.rst | 10 ++++++----
>>  1 file changed, 6 insertions(+), 4 deletions(-)
>>
>> diff --git a/documentation/dev-manual/debugging.rst
>> b/documentation/dev-manual/debugging.rst
>> index 92458a0c37..6b5d2dd820 100644
>> --- a/documentation/dev-manual/debugging.rst
>> +++ b/documentation/dev-manual/debugging.rst
>> @@ -1006,8 +1006,9 @@ debugger.
>>
>>        IMAGE_GEN_DEBUGFS = "1"
>>        IMAGE_FSTYPES_DEBUGFS = "tar.bz2"
>> +      IMAGE_FSTYPES:append = " tar.bz2"
>>
>> -   These options cause the
>> +   The first two lines cause the
>>     OpenEmbedded build system to generate a special companion filesystem
>>     fragment, which contains the matching source and debug symbols to
>>     your deployable filesystem. The build system does this by looking at
>> @@ -1016,8 +1017,9 @@ debugger.
>>
>>     The companion debug filesystem is not a complete filesystem, but only
>>     contains the debug fragments. This filesystem must be combined with
>> -   the full filesystem for debugging. Subsequent steps in this procedure
>> -   show how to combine the partial filesystem with the full filesystem.
>> +   the full filesystem for debugging. The third line ensures that the
>> +   build system generates a tar.bz2-formatted copy of the full filesystem,
>> +   which will be used in subsequent steps in this procedure.
>>
>
> Would a link to
> https://docs.yoctoproject.org/sdk-manual/extensible.html#devtool-ide-sdk-configures-ides-for-the-extensible-sdk
> be helpful here?
> This tool creates this setup automatically, even without creating a big tar
> and extracting it again.

Indeed, this would make sense I agree. I would perhaps add it after the sentence
a bit further up after "The following steps show you how to debug using the GNU
project debugger." as a `.. note::`. What do you think? Would you be able to add
that note?

Cheers,
Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com