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

Eli Zaretskii
2013-05-21T17:17:48Z

> From: Joel Brobecker <brobecker@adacore.com>
> Date: Tue, 21 May 2013 13:24:48 +0400
>
> This documents the introduction of new scripts provided in
> a GDB install.

Thanks.

> 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.

> +@subsection System-wide configuration scripts provided by @value{GDBN}

Each subsection should have at least one @cindex entry about its main
subject(s).

> +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
^^
Two spaces.

> +automatically source those scripts at startup, @value{GDBN} should be
> +configured with @option{-with-system-gdbinit}. Otherwise, any user
^
One more hyphen.

> +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.

There should be a @cindex entry for each of these items, and possibly
also a @pindex entry with the name of the script. Think about a
reader who knows she read about these somewhere in this humongous
manual, and just forgot where...

OK with those changes.

Btw, with all those scripts we distribute and install, perhaps we
should start thinking about installing them into version-specific
directories. It becomes harder and harder to have more than one
operable GDB version on the same system, because new features cause
older GDB to barf.