[RFA/Doco] Document new <data-dir>/system-gdbinit area

Joel Brobecker
2013-05-21T09:25:29Z

This documents the introduction of new scripts provided in
a GDB install.

Ref: http://www.sourceware.org/ml/gdb-patches/2013-05/msg00382.html

gdb/doc/ChangeLog:

* gdb.texinfo (System-wide configuration): Add subsection
describing the scripts now available under the data-dir's
system-gdbbinit subdirectory.

OK to apply? Should I also add a NEWS entry for this?

Thank you,
--
Joel

---
gdb/doc/gdb.texinfo | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 43b0104..111e352 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -36332,6 +36332,32 @@ initialization. If the data-directory is changed after @value{GDBN} has
started with the @code{set data-directory} command, the file will not be
reread.

+@subsection System-wide configuration scripts provided by @value{GDBN}
+
+The @file{system-gdbinit} directory, located inside the data-directory
+(as specified by @option{--with-gdb-datadir} at configure time) contains
+a number of scripts which can be used as system-wide init files. To
+automatically source those scripts at startup, @value{GDBN} should be
+configured with @option{-with-system-gdbinit}. Otherwise, any user
+should be able to source them by hand as needed.
+
+The following scripts are currently available:
+@itemize @bullet
+
+@item @file{elinos.py}
+This script is useful when debugging a program on an ELinOS target.
+It takes advantage of the environment variables defined in a standard
+ELinOS environment in order to determine the location of the system
+shared libraries, and then sets the @samp{solib-absolute-prefix}
+and @samp{solib-search-path} variables appropriately.
+
+@item @file{wrs-linux.py}
+This script is useful when debugging a program on a target running
+Wind River Linux. It expects the @env{ENV_PREFIX} to be set to
+the host-side sysroot used by the target system.
+
+@end itemize
+
@node Maintenance Commands
@appendix Maintenance Commands
@cindex maintenance commands
--
1.7.10.4