summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorDorinda <dorindabassey@gmail.com>2021-03-02 18:06:51 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-03-23 22:54:55 +0000
commit6c9829385ecf78d3dae295cf8a010197d0f87327 (patch)
tree678d04ed3a8e1490c37b655852fe4234d02c9701 /documentation
parent2d80d02edbf99775e9fd7465cb80891bf6fa738a (diff)
downloadpoky-6c9829385ecf78d3dae295cf8a010197d0f87327.tar.gz
dev-manual/common-task.rst: Added documentation for debuginfod support
Added documentation on running debuginfod server and using it on the target. Added the term DEBUGINFOD_URLS definition in ref-manual/variables.rst (From yocto-docs rev: a16ae140e26482c81ce733f20f8c68c6eba55f35) Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/common-tasks.rst47
-rw-r--r--documentation/ref-manual/variables.rst6
2 files changed, 52 insertions, 1 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 820b8314d1..4313d905ca 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -10023,7 +10023,52 @@ before starting the debugging process. These extra computations place
10023more load on the target system and can alter the characteristics of the 10023more load on the target system and can alter the characteristics of the
10024program being debugged. 10024program being debugged.
10025 10025
10026To help get past the previously mentioned constraints, you can use 10026To help get past the previously mentioned constraints, there are two
10027methods you can use: running a debuginfod server and using gdbserver.
10028
10029Using the debuginfod server method
10030~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10031
10032"debuginfod" from "elfutils" is a way to distribute "debuginfo" files.
10033Running a "debuginfod" server makes debug symbols readily available,
10034which means you don't need to download debugging information
10035and the binaries of the process being debugged. You can just fetch
10036debug symbols from the server.
10037
10038To run a debuginfod server, you need to do the following:
10039
10040- Ensure that this variable is set in your ``local.conf`` file:
10041 ::
10042
10043 PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
10044
10045 This :term:`PACKAGECONFIG` option enables debuginfod and libdebuginfod for
10046 "elfutils-native".
10047
10048- Run the following commands to set up the "debuginfod" server:
10049 ::
10050
10051 $ oe-debuginfod
10052
10053
10054To use debuginfod on the target, you need the following:
10055
10056- Ensure that this variable is set in your ``local.conf`` file:
10057 ::
10058
10059 DEBUGINFOD_URLS = "http://localhost:8002/"
10060
10061 This :term:`DEBUGINFOD_URLS` option does the client configuration.
10062
10063 ::
10064
10065 PACKAGECONFIG_pn-gdb = "debuginfod"
10066
10067 This :term:`PACKAGECONFIG` option enables "debuginfod" for "gdb".
10068
10069Using the gdbserver method
10070~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10071
10027gdbserver, which runs on the remote target and does not load any 10072gdbserver, which runs on the remote target and does not load any
10028debugging information from the debugged process. Instead, a GDB instance 10073debugging information from the debugged process. Instead, a GDB instance
10029processes the debugging information that is run on a remote computer - 10074processes the debugging information that is run on a remote computer -
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 4f441907b1..0310429bdc 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1565,6 +1565,12 @@ system and gives an overview of their function and contents.
1565 1565
1566 DEBIANNAME_${PN} = "dbus-1" 1566 DEBIANNAME_${PN} = "dbus-1"
1567 1567
1568 :term:`DEBUGINFOD_URLS`
1569 Points to the URL of the "debuginfod" server. Such that for every
1570 debugging information lookup, the debuginfod client will query the
1571 server and return the requested information. You set this variable
1572 in your ``local.conf`` file.
1573
1568 :term:`DEBUG_BUILD` 1574 :term:`DEBUG_BUILD`
1569 Specifies to build packages with debugging information. This 1575 Specifies to build packages with debugging information. This
1570 influences the value of the ``SELECTED_OPTIMIZATION`` variable. 1576 influences the value of the ``SELECTED_OPTIMIZATION`` variable.