* [PATCH] dev-manual/common-task.rst: Added documentation for debuginfod support
@ 2021-03-01 15:49 Dorinda
2021-03-01 18:18 ` [docs] " Quentin Schulz
0 siblings, 1 reply; 3+ messages in thread
From: Dorinda @ 2021-03-01 15:49 UTC (permalink / raw)
To: docs; +Cc: dorindabassey
Added documentation on running debuginfod server and using it on the target.
Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com>
---
documentation/dev-manual/common-tasks.rst | 46 ++++++++++++++++++++++-
1 file changed, 45 insertions(+), 1 deletion(-)
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 65db4aed33..d4a2b2f28d 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -10023,7 +10023,51 @@ before starting the debugging process. These extra computations place
more load on the target system and can alter the characteristics of the
program being debugged.
-To help get past the previously mentioned constraints, you can use
+To help get past the previously mentioned constraints, they're two
+methods you can use: running a debuginfod server and using gdbserver.
+
+Using the debuginfod server Method
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+debuginfod from elfutils is a way to distribute debuginfo files.
+running a debuginfod server makes debug symbols readily available,
+which means you don't need to download debugging information
+and the binaries of the process being debugged. you can just fetch
+debug symbols from the server.
+
+1. To run a debuginfod server, you need to do the following:
+
+- Ensure that this variable is set in your ``local.conf`` file:
+ ::
+
+ PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
+
+ This PACKAGECONFIG option enables debuginfod and libdebuginfod for
+ elfutils-native.
+
+- Run the following commands to set up the debuginfod server:
+ ::
+
+ $ oe-debuginfod
+2. To use debuginfod on the target, you need the following:
+
+- Ensure that these variable is set in your ``local.conf`` file:
+ ::
+
+ DEBUGINFOD_URLS = "http://localhost:port"
+
+ This option does the client configuration by setting DEBUGINFOD_URLS
+ to point at the server running debuginfod. Such that for every lookup,
+ the debuginfod client will query the server and return the requested information.
+ ::
+
+ PACKAGECONFIG_pn-gdb = "debuginfod"
+
+ This PACKAGECONFIG option enables debuginfod for gdb.
+
+Using the gdbserver Method
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
gdbserver, which runs on the remote target and does not load any
debugging information from the debugged process. Instead, a GDB instance
processes the debugging information that is run on a remote computer -
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [docs] [PATCH] dev-manual/common-task.rst: Added documentation for debuginfod support
2021-03-01 15:49 [PATCH] dev-manual/common-task.rst: Added documentation for debuginfod support Dorinda
@ 2021-03-01 18:18 ` Quentin Schulz
2021-03-01 19:31 ` Dorinda
0 siblings, 1 reply; 3+ messages in thread
From: Quentin Schulz @ 2021-03-01 18:18 UTC (permalink / raw)
To: Dorinda; +Cc: docs
Hi Dorinda,
Mainly nitpicks.
On Mon, Mar 01, 2021 at 04:49:52PM +0100, Dorinda wrote:
> Added documentation on running debuginfod server and using it on the target.
>
> Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com>
> ---
> documentation/dev-manual/common-tasks.rst | 46 ++++++++++++++++++++++-
> 1 file changed, 45 insertions(+), 1 deletion(-)
>
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index 65db4aed33..d4a2b2f28d 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -10023,7 +10023,51 @@ before starting the debugging process. These extra computations place
> more load on the target system and can alter the characteristics of the
> program being debugged.
>
> -To help get past the previously mentioned constraints, you can use
> +To help get past the previously mentioned constraints, they're two
s/they're/there are/
> +methods you can use: running a debuginfod server and using gdbserver.
> +
> +Using the debuginfod server Method
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
s/Method/method/
> +debuginfod from elfutils is a way to distribute debuginfo files.
I'd probably double tick quote debuginfod, debuginfo and elfutils.
> +running a debuginfod server makes debug symbols readily available,
s/running/Running/
Quoting debuginfod.
> +which means you don't need to download debugging information
> +and the binaries of the process being debugged. you can just fetch
s/you/You/
> +debug symbols from the server.
> +
> +1. To run a debuginfod server, you need to do the following:
> +
> +- Ensure that this variable is set in your ``local.conf`` file:
Not sure a numbered item list followed by a "simple" list works fine, have
you compiled the docs with your patch? Does it render weird?
Thinking about it, you might be missing a three space indentation on the
"simple" list?
Just throwing out my lack of knowledge in the conversation right now :D
> + ::
> +
> + PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
> +
> + This PACKAGECONFIG option enables debuginfod and libdebuginfod for
s/PACKAGECONFIG/:term:`PACKAGECONFIG`/
Quoting debuginfod and libdebuginfod.
I've missed most of the discussion around debuginfo feature/support so
forgive me if it's complete non-sense, but... do we really want to tell
people to put PACKAGECONFIG_pn-elfutils-native in their local.conf
instead of creating a bbappend for elfutils in their own layer? Or add
that line to their distro conf file and not local.conf?
For me, local.conf is for temporary use but it might make sense for some
people/company to always have debuginfo enabled in their builds?
Just asking, being curious right now :)
> + elfutils-native.
> +
> +- Run the following commands to set up the debuginfod server:
Quoting debuginfod and elfutils-native.
> + ::
> +
> + $ oe-debuginfod
Probably missing at least a newline if not two to end the code blocks
IIRC from my experience.
> +2. To use debuginfod on the target, you need the following:
> +
> +- Ensure that these variable is set in your ``local.conf`` file:
s/these/this/
> + ::
> +
> + DEBUGINFOD_URLS = "http://localhost:port"
> +
> + This option does the client configuration by setting DEBUGINFOD_URLS
I'd add an entry in the variable glossary for DEBUGINFOD_URLS and then:
s/DEBUGINFOD_URLS/:term:`DEBUGINFOD_URLS`/
> + to point at the server running debuginfod. Such that for every lookup,
> + the debuginfod client will query the server and return the requested information.
> + ::
> +
> + PACKAGECONFIG_pn-gdb = "debuginfod"
> +
> + This PACKAGECONFIG option enables debuginfod for gdb.
s/PACKAGECONFIG/:term:`PACKAGECONFIG`/
Quoting debuginfod and gdb the few instances above.
> +
> +Using the gdbserver Method
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
s/Method/method/
Thanks,
Quentin
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [docs] [PATCH] dev-manual/common-task.rst: Added documentation for debuginfod support
2021-03-01 18:18 ` [docs] " Quentin Schulz
@ 2021-03-01 19:31 ` Dorinda
0 siblings, 0 replies; 3+ messages in thread
From: Dorinda @ 2021-03-01 19:31 UTC (permalink / raw)
To: Quentin Schulz; +Cc: docs
[-- Attachment #1: Type: text/plain, Size: 4671 bytes --]
Hi Quentin,
Thanks for the review, noted your points and putting them into
consideration.
have
you compiled the docs with your patch? Does it render weird?
This was an oversight, I didn't know docs were compiled separately,
Currently looking at the documentation readme now.
About the PACKAGECONFIG_pn-elfutils-native in local.conf, the intent there
was for it to be an optional configuration option, since not everyone might
want to use a debuginfod server.
Thanks,
Dorinda.
On Mar 1, 2021 7:18 PM, "Quentin Schulz" <quentin.schulz@streamunlimited.com>
wrote:
Hi Dorinda,
Mainly nitpicks.
On Mon, Mar 01, 2021 at 04:49:52PM +0100, Dorinda wrote:
> Added documentation on running debuginfod server and using it on the
target.
>
> Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com>
> ---
> documentation/dev-manual/common-tasks.rst | 46 ++++++++++++++++++++++-
> 1 file changed, 45 insertions(+), 1 deletion(-)
>
> diff --git a/documentation/dev-manual/common-tasks.rst
b/documentation/dev-manual/common-tasks.rst
> index 65db4aed33..d4a2b2f28d 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -10023,7 +10023,51 @@ before starting the debugging process. These
extra computations place
> more load on the target system and can alter the characteristics of the
> program being debugged.
>
> -To help get past the previously mentioned constraints, you can use
> +To help get past the previously mentioned constraints, they're two
s/they're/there are/
> +methods you can use: running a debuginfod server and using gdbserver.
> +
> +Using the debuginfod server Method
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
s/Method/method/
> +debuginfod from elfutils is a way to distribute debuginfo files.
I'd probably double tick quote debuginfod, debuginfo and elfutils.
> +running a debuginfod server makes debug symbols readily available,
s/running/Running/
Quoting debuginfod.
> +which means you don't need to download debugging information
> +and the binaries of the process being debugged. you can just fetch
s/you/You/
> +debug symbols from the server.
> +
> +1. To run a debuginfod server, you need to do the following:
> +
> +- Ensure that this variable is set in your ``local.conf`` file:
Not sure a numbered item list followed by a "simple" list works fine, have
you compiled the docs with your patch? Does it render weird?
Thinking about it, you might be missing a three space indentation on the
"simple" list?
Just throwing out my lack of knowledge in the conversation right now :D
> + ::
> +
> + PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
> +
> + This PACKAGECONFIG option enables debuginfod and libdebuginfod for
s/PACKAGECONFIG/:term:`PACKAGECONFIG`/
Quoting debuginfod and libdebuginfod.
I've missed most of the discussion around debuginfo feature/support so
forgive me if it's complete non-sense, but... do we really want to tell
people to put PACKAGECONFIG_pn-elfutils-native in their local.conf
instead of creating a bbappend for elfutils in their own layer? Or add
that line to their distro conf file and not local.conf?
For me, local.conf is for temporary use but it might make sense for some
people/company to always have debuginfo enabled in their builds?
Just asking, being curious right now :)
> + elfutils-native.
> +
> +- Run the following commands to set up the debuginfod server:
Quoting debuginfod and elfutils-native.
> + ::
> +
> + $ oe-debuginfod
Probably missing at least a newline if not two to end the code blocks
IIRC from my experience.
> +2. To use debuginfod on the target, you need the following:
> +
> +- Ensure that these variable is set in your ``local.conf`` file:
s/these/this/
> + ::
> +
> + DEBUGINFOD_URLS = "http://localhost:port"
> +
> + This option does the client configuration by setting DEBUGINFOD_URLS
I'd add an entry in the variable glossary for DEBUGINFOD_URLS and then:
s/DEBUGINFOD_URLS/:term:`DEBUGINFOD_URLS`/
> + to point at the server running debuginfod. Such that for every
lookup,
> + the debuginfod client will query the server and return the requested
information.
> + ::
> +
> + PACKAGECONFIG_pn-gdb = "debuginfod"
> +
> + This PACKAGECONFIG option enables debuginfod for gdb.
s/PACKAGECONFIG/:term:`PACKAGECONFIG`/
Quoting debuginfod and gdb the few instances above.
> +
> +Using the gdbserver Method
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
s/Method/method/
Thanks,
Quentin
[-- Attachment #2: Type: text/html, Size: 6637 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-03-01 19:31 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-01 15:49 [PATCH] dev-manual/common-task.rst: Added documentation for debuginfod support Dorinda
2021-03-01 18:18 ` [docs] " Quentin Schulz
2021-03-01 19:31 ` Dorinda
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.