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

Joel Brobecker
2013-05-22T06:28:25Z

[-- Attachment #1: Type: text/plain, Size: 979 bytes --]

> > gdb/doc/ChangeLog:
> >
> > * gdb.texinfo (System-wide configuration): Add subsection
> > describing the scripts now available under the data-dir's
> > system-gdbbinit subdirectory.
>
> Ugh, a subsection without a @node... Why people like them so much?
> They make navigation inside an Info reader harder.

I didn't know... I will gladly fix it.

First attached is a patch which provides the changes made on top
of the first submission, showing the changes I made based on your
feedback. It also includes a NEWS entry.

And second patch is the actual full patch.

gdb/doc/ChangeLog:

* gdb.texinfo (Installed System-wide Configuration Scripts):
Add subsection describing the scripts now available under
the data-dir's system-gdbbinit subdirectory.
* NEWS: Add entry announcing the availability of system-wide
configuration scripts for ElinOS and Wind River Linux.

OK to commit?

Thank you,
--
Joel
--
Joel

[-- Attachment #2: doco-fixes.diff --]
[-- Type: text/x-diff, Size: 2754 bytes --]

From 76d5c10e6a7baff4f88f2a77d51bb7234bb247b4 Mon Sep 17 00:00:00 2001
From: Joel Brobecker <brobecker@adacore.com>
Date: Wed, 22 May 2013 10:21:55 +0400
Subject: [PATCH] Adjustments to doco patch re: system-gdbinit scripts.

---
gdb/NEWS | 6 ++++++
gdb/doc/gdb.texinfo | 12 +++++++++---
2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/gdb/NEWS b/gdb/NEWS
index e09907c..458c5f1 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -72,6 +72,12 @@ show debug nios2

** The new command -dprintf-insert sets a dynamic printf breakpoint.

+* New system-wide configuration scripts
+ A GDB installation now provides scripts suitable as system-wide
+ configuration scripts for the following systems:
+ ** ElinOS
+ ** Wind River Linux
+
*** Changes in GDB 7.6

* Target record has been renamed to record-full.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 111e352..cb98135 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -36332,19 +36332,23 @@ 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}
+@node Installed System-wide Configuration Scripts
+@subsection Installed System-wide Configuration Scripts
+@cindex System-wide configuration scripts

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
+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
+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}
+@pindex elinos.py
+@cindex ELinOS system-wide configuration script
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
@@ -36352,6 +36356,8 @@ shared libraries, and then sets the @samp{solib-absolute-prefix}
and @samp{solib-search-path} variables appropriately.

@item @file{wrs-linux.py}
+@pindex wrs-linux.py
+@cindex Wind River Linux system-wide configuration script
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.
--
1.7.10.4

[-- Attachment #3: 0001-Document-new-data-dir-system-gdbinit-area.patch --]
[-- Type: text/x-diff, Size: 2970 bytes --]

From 1cecd9968f0f8c1a8ec7f5efba741a288026e71a Mon Sep 17 00:00:00 2001
From: Joel Brobecker <brobecker@adacore.com>
Date: Tue, 21 May 2013 13:18:54 +0400
Subject: [PATCH] Document new <data-dir>/system-gdbinit area

gdb/doc/ChangeLog:

* gdb.texinfo (Installed System-wide Configuration Scripts):
Add subsection describing the scripts now available under
the data-dir's system-gdbbinit subdirectory.
* NEWS: Add entry announcing the availability of system-wide
configuration scripts for ElinOS and Wind River Linux.
---
gdb/NEWS | 6 ++++++
gdb/doc/gdb.texinfo | 32 ++++++++++++++++++++++++++++++++
2 files changed, 38 insertions(+)

diff --git a/gdb/NEWS b/gdb/NEWS
index e09907c..c6a5e5d 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -72,6 +72,12 @@ show debug nios2

** The new command -dprintf-insert sets a dynamic printf breakpoint.

+* New system-wide configuration scripts
+ A GDB installation now provides scripts suitable for use as system-wide
+ configuration scripts for the following systems:
+ ** ElinOS
+ ** Wind River Linux
+
*** Changes in GDB 7.6

* Target record has been renamed to record-full.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 43b0104..cb98135 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -36332,6 +36332,38 @@ 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.

+@node Installed System-wide Configuration Scripts
+@subsection Installed System-wide Configuration Scripts
+@cindex System-wide configuration scripts
+
+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}
+@pindex elinos.py
+@cindex ELinOS system-wide configuration script
+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}
+@pindex wrs-linux.py
+@cindex Wind River Linux system-wide configuration script
+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