Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Joel Brobecker <brobecker@adacore.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [RFA/Doco] Document new <data-dir>/system-gdbinit area
Date: Tue, 21 May 2013 17:17:00 -0000	[thread overview]
Message-ID: <83d2skuuai.fsf@gnu.org> (raw)
In-Reply-To: <1369128288-3495-1-git-send-email-brobecker@adacore.com>

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


  parent reply	other threads:[~2013-05-21 17:17 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-05-21  9:25 Joel Brobecker
2013-05-21 15:34 ` Pedro Alves
2013-05-21 17:37   ` Eli Zaretskii
2013-05-21 17:17 ` Eli Zaretskii [this message]
2013-05-22  6:28   ` Joel Brobecker
2013-05-22 14:54     ` Eli Zaretskii
2013-05-23  6:08       ` Checked in: " Joel Brobecker
2013-05-24  1:33         ` asmwarrior
2013-05-24  4:53           ` Joel Brobecker
2013-05-24  5:06             ` Joel Brobecker
2013-05-24  6:24             ` Eli Zaretskii
2013-05-22  6:44   ` Joel Brobecker

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83d2skuuai.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=brobecker@adacore.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox