summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-08-12 16:07:47 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-09-22 13:04:42 +0100
commit9cc019b9ea135836d0c24d0e5c93830f47cc4595 (patch)
tree2c60faccf617757ad527adbaa64fb363a81beb15 /documentation
parent05fabfca18299058d985fd4c8b1e11bbee3c5968 (diff)
downloadpoky-9cc019b9ea135836d0c24d0e5c93830f47cc4595.tar.gz
ref-manual: Added PACKAGE_DEBUG_SPLIT_STYLE variable.
Fixes [YOCTO #6621] This is a new variable that helps control how debug symbols and source files are split off when creating -dbg files for use with GDB. (From yocto-docs rev: 506b79707f6aec7c14f1f9d7e5099d20fca45c0e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml56
1 files changed, 56 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 7ea753df71..a4dbba4a3e 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -5722,6 +5722,62 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5722 </glossdef> 5722 </glossdef>
5723 </glossentry> 5723 </glossentry>
5724 5724
5725 <glossentry id='var-PACKAGE_DEBUG_SPLIT_STYLE'><glossterm>PACKAGE_DEBUG_SPLIT_STYLE</glossterm>
5726 <glossdef>
5727
5728 <para>
5729 Determines how to split up the binary and debug information
5730 when creating <filename>*-dbg</filename> packages to be
5731 used with the GNU Project Debugger (GDB).
5732 </para>
5733
5734 <para>
5735 With the
5736 <filename>PACKAGE_DEBUG_SPLIT_STYLE</filename> variable,
5737 you can control where debug information, which can include
5738 or exclude source files, is stored:
5739 <itemizedlist>
5740 <listitem><para>
5741 ".debug": Debug symbol files are placed next
5742 to the binary in a <filename>.debug</filename>
5743 directory on the target.
5744 For example, if a binary is installed into
5745 <filename>/bin</filename>, the corresponding debug
5746 symbol files are installed in
5747 <filename>/bin/.debug</filename>.
5748 Source files are placed in
5749 <filename>/usr/src/debug</filename>.
5750 This is the default behavior.
5751 </para></listitem>
5752 <listitem><para>
5753 "debug-file-directory": Debug symbol files are
5754 placed under <filename>/usr/lib/debug</filename>
5755 on the target, and separated by the path from where
5756 the binary is installed.
5757 For example, if a binary is installed in
5758 <filename>/bin</filename>, the corresponding debug
5759 symbols are installed in
5760 <filename>/usr/lib/debug/bin</filename>.
5761 Source files are placed in
5762 <filename>/usr/src/debug</filename>.
5763 </para></listitem>
5764 <listitem><para>
5765 "debug-without-src": The same behavior as
5766 ".debug" previously described with the exception
5767 that no source files are installed.
5768 </para></listitem>.
5769 </itemizedlist>
5770 </para>
5771
5772 <para>
5773 You can find out more about debugging using GDB by reading
5774 the
5775 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>"
5776 section in the Yocto Project Development Manual.
5777 </para>
5778 </glossdef>
5779 </glossentry>
5780
5725 <glossentry id='var-PACKAGE_EXCLUDE'><glossterm>PACKAGE_EXCLUDE</glossterm> 5781 <glossentry id='var-PACKAGE_EXCLUDE'><glossterm>PACKAGE_EXCLUDE</glossterm>
5726 <glossdef> 5782 <glossdef>
5727 <para> 5783 <para>