Bug 6620 - Add a quick example about .gdbinit
Summary: Add a quick example about .gdbinit
Status: RESOLVED FIXED
Alias: None
Product: Development Manual
Classification: Documentation
Component: development (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Medium normal
Target Milestone: 1.7
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 15 August 2014: RESOLVED
Depends on:
Blocks:
 
Reported: 2014-08-08 11:37 UTC by Laszlo Papp
Modified: 2014-08-15 05:51 UTC (History)
0 users

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Laszlo Papp 2014-08-08 11:37:08 UTC
The documentation here writes what to put into the .gdbinit file, but it does not actually let the reader know where to put that: 

http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#platdev-gdb-remotedebug-launch-gdb

Sure, it would be possible to go to Google or the gdb manual for figuring out, but since it could be a one-liner extension to be self-contained without jumping to external sites, I would personally suggest to add this to the manual:

existing line: set sysroot /home/jzhang/sysroot_arm

addition: Add this content to ~/.gdbinit.

For that matter, I would probably also replace "/home/jzhang" with "~" to be more user-agnostic and more generic.
Comment 1 Scott Rifenbark 2014-08-08 12:39:18 UTC
Hi,

I have specified the .gdbinit file in the preceding text as "~/.gdbinit" to reinforce the location of the file.  The text prior to the example did specify that the following example statement did need to be added to .gbdinit.  Adding "~/" to the filename will leave leave no questions about what the user needs to modify.  

I have also replaced /home/jzhang with ~ as suggested.

You can see the changes at http://www.yoctoproject.org/docs/1.7/dev-manual/dev-manual.html#create-the-gdb-initialization-file.

Marking status as IN PROGRESS REVIEW.

Scott
Comment 2 Laszlo Papp 2014-08-08 13:29:34 UTC
Looks good, thanks!
Comment 3 Scott Rifenbark 2014-08-15 05:51:24 UTC
Thanks for the check.  Marking as RESOLVED and doc flag to "Done."

Scott