From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: YP docs mailing list <docs@lists.yoctoproject.org>
Subject: [PATCH] ref-manual: extend explanation of PACKAGE_DEBUG_SPLIT_STYLE
Date: Sat, 18 Sep 2021 07:57:14 -0400 (EDT) [thread overview]
Message-ID: <b9acb74f-7823-f8cc-f6f4-9d45fd5dace8@crashcourse.ca> (raw)
The current explanation of this variable seems incomplete, so be a
bit more verbose to make sure the reader understands the packaging
possibilities.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
---
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 5caada626..a46ea186e 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5064,33 +5064,39 @@ system and gives an overview of their function and contents.
":ref:`package.bbclass <ref-classes-package>`" section.
:term:`PACKAGE_DEBUG_SPLIT_STYLE`
- Determines how to split up the binary and debug information when
- creating ``*-dbg`` packages to be used with the GNU Project Debugger
- (GDB).
-
- With the :term:`PACKAGE_DEBUG_SPLIT_STYLE` variable, you can control
- where debug information, which can include or exclude source files,
- is stored:
-
- - ".debug": Debug symbol files are placed next to the binary in a
- ``.debug`` directory on the target. For example, if a binary is
- installed into ``/bin``, the corresponding debug symbol files are
- installed in ``/bin/.debug``. Source files are placed in
- ``/usr/src/debug``.
-
- - "debug-file-directory": Debug symbol files are placed under
- ``/usr/lib/debug`` on the target, and separated by the path from
- where the binary is installed. For example, if a binary is
- installed in ``/bin``, the corresponding debug symbols are
- installed in ``/usr/lib/debug/bin``. Source files are placed in
- ``/usr/src/debug``.
-
- - "debug-without-src": The same behavior as ".debug" previously
- described with the exception that no source files are installed.
-
- - "debug-with-srcpkg": The same behavior as ".debug" previously
- described with the exception that all source files are placed in a
- separate ``*-src`` pkg. This is the default behavior.
+ Determines how to split up and package debug and source information
+ when creating debugging packages to be used with the GNU Project
+ Debugger (GDB). In general, based on the value of this variable,
+ you can combine the source and debug info in a single package,
+ you can break out the source into a separate package that can be
+ installed independently, or you can choose to not have the source
+ packaged at all.
+
+ The possible values of :term:`PACKAGE_DEBUG_SPLIT_STYLE` variable:
+
+ - "``.debug``": All debugging and source info is placed in a single
+ ``*-dbg`` package; debug symbol files are placed next to the
+ binary in a ``.debug`` directory so that, if a binary is installed
+ into ``/bin``, the corresponding debug symbol file is installed
+ in ``/bin/.debug``. Source files are installed in the same ``*-dbg``
+ package under ``/usr/src/debug``.
+
+ - "``debug-file-directory``": As above, all debugging and source info
+ is placed in a single ``*-dbg`` package; debug symbol files are
+ placed entirely under the directory ``/usr/lib/debug`` and separated
+ by the path from where the binary is installed, so that if a binary
+ is installed in ``/bin``, the corresponding debug symbols are installed
+ in ``/usr/lib/debug/bin``, and so on. As above, source is installed
+ in the same package under ``/usr/src/debug``.
+
+ - "``debug-with-srcpkg``": Debugging info is placed in the standard
+ ``*-dbg`` package as with the ``.debug`` value, while source is
+ placed in a separate ``*-src`` package, which can be installed
+ independently. This is the default setting for this variable,
+ as defined in Poky's ``bitbake.conf`` file.
+
+ - "``debug-without-src``": The same behavior as with the ``.debug``
+ setting, but no source is packaged at all.
You can find out more about debugging using GDB by reading the
":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
next reply other threads:[~2021-09-18 11:57 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-18 11:57 Robert P. J. Day [this message]
2021-09-21 17:56 ` [docs] [PATCH] ref-manual: extend explanation of PACKAGE_DEBUG_SPLIT_STYLE Michael Opdenacker
2021-09-21 18:20 ` Robert P. J. Day
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b9acb74f-7823-f8cc-f6f4-9d45fd5dace8@crashcourse.ca \
--to=rpjday@crashcourse.ca \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).