ryan77627/guix
1
0
Fork 0
mirror of https://git.in.rschanz.org/ryan77627/guix.git synced 2024-12-25 13:58:15 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Improve debugging file documentation.

Browse source 
* doc/guix.texi (Installing Debugging Files): Add @cindex.  Remove
  unneeded '-i' in example.  Mention source code an 'directory'.  Link
  to "Build Systems" instead of "Defining Packages".
This commit is contained in:
Ludovic Courtès 2014-05-13 21:22:38 +02:00
parent 1a389e8d21
commit 64d76fa6c2
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/guix.texi
View file

@ -2604,6 +2604,7 @@ to join! @ref{Contributing}, for information about how you can help.
@node Installing Debugging Files @node Installing Debugging Files
@section Installing Debugging Files @section Installing Debugging Files
@cindex debugging files
Program binaries, as produced by the GCC compilers for instance, are Program binaries, as produced by the GCC compilers for instance, are
typically written in the ELF format, with a section containing typically written in the ELF format, with a section containing
@dfn{debugging information}. Debugging information is what allows the @dfn{debugging information}. Debugging information is what allows the
@ -2634,7 +2635,7 @@ installs the debugging information for the GNU C Library and for GNU
Guile: Guile:
@example @example
guix package -i glibc:debug -i guile:debug guix package -i glibc:debug guile:debug
@end example @end example
GDB must then be told to look for debug files in the user's profile, by GDB must then be told to look for debug files in the user's profile, by
@ -2649,9 +2650,16 @@ GDB}):
From there on, GDB will pick up debugging information from the From there on, GDB will pick up debugging information from the
@code{.debug} files under @file{~/.guix-profile/lib/debug}. @code{.debug} files under @file{~/.guix-profile/lib/debug}.
In addition, you will most likely want GDB to be able to show the source
code being debugged. To do that, you will have to unpack the source
code of the package of interest (obtained with @code{guix build
--source}, @pxref{Invoking guix build}), and to point GDB to that source
directory using the @code{directory} command (@pxref{Source Path,
@code{directory},, gdb, Debugging with GDB}).
@c XXX: keep me up-to-date @c XXX: keep me up-to-date
The @code{debug} output mechanism in Guix is implemented by the The @code{debug} output mechanism in Guix is implemented by the
@code{gnu-build-system} (@pxref{Defining Packages}). Currently, it is @code{gnu-build-system} (@pxref{Build Systems}). Currently, it is
opt-in---debugging information is available only for those packages opt-in---debugging information is available only for those packages
whose definition explicitly declares a @code{debug} output. This may be whose definition explicitly declares a @code{debug} output. This may be
changed to opt-out in the future, if our build farm servers can handle changed to opt-out in the future, if our build farm servers can handle