Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Doug Evans <dje@google.com>
To: gdb-patches@sourceware.org, eliz@gnu.org
Subject: [PATCH 1/2] Add objfile.username: improve docs for Objfile.filename
Date: Tue, 20 Jan 2015 23:03:00 -0000	[thread overview]
Message-ID: <yjt2fvb5kqc5.fsf@ruffy.mtv.corp.google.com> (raw)

Hi.

I have a need to expose objfile->original_name to python.
In order to do that I need to tweak the docs for Objfile.filename
to distinguish how it's different.

2015-01-20  Doug Evans  <dje@google.com>

	* python.texi (Objfiles In Python) <Objfile.filename>: Improve docs.
	* guile.texi (Objfiles In Guile) <objfile-filename>: Improve docs.

diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi
index 8355d9f..53e69f2 100644
--- a/gdb/doc/guile.texi
+++ b/gdb/doc/guile.texi
@@ -2246,7 +2246,8 @@ if it is invalid at the time the procedure is called.
 @end deffn
 
 @deffn {Scheme Procedure} objfile-filename objfile
-Return the file name of @var{objfile} as a string.
+Return the file name of @var{objfile} as a string,
+with symbolic links resolved.
 @end deffn
 
 @deffn {Scheme Procedure} objfile-pretty-printers objfile
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index b9a50d0..ba03841 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -3513,7 +3513,10 @@ Each objfile is represented by an instance of the @code{gdb.Objfile}
 class.
 
 @defvar Objfile.filename
-The file name of the objfile as a string.
+The file name of the objfile as a string, with symbolic links resolved.
+
+The value is @code{None} if the objfile is no longer valid.
+See the @code{gdb.Objfile.is_valid} method, described below.
 @end defvar
 
 @defvar Objfile.owner


             reply	other threads:[~2015-01-20 23:03 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-20 23:03 Doug Evans [this message]
2015-01-21  3:41 ` Eli Zaretskii
2015-01-27 18:33   ` Doug Evans

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=yjt2fvb5kqc5.fsf@ruffy.mtv.corp.google.com \
    --to=dje@google.com \
    --cc=eliz@gnu.org \
    --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