diff mbox

[1/2] Add objfile.username: improve docs for Objfile.filename

Message ID yjt2fvb5kqc5.fsf@ruffy.mtv.corp.google.com
State New, archived
Headers

Commit Message

Doug Evans Jan. 20, 2015, 11:03 p.m. UTC 
  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.

Comments

Eli Zaretskii Jan. 21, 2015, 3:41 a.m. UTC | #1 
> From: Doug Evans <dje@google.com>
> Date: Tue, 20 Jan 2015 15:03:06 -0800
> 
> 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.

This is OK, thanks.
Doug Evans Jan. 27, 2015, 6:05 p.m. UTC | #2 
On Tue, Jan 20, 2015 at 7:41 PM, Eli Zaretskii <eliz@gnu.org> wrote:
>> From: Doug Evans <dje@google.com>
>> Date: Tue, 20 Jan 2015 15:03:06 -0800
>>
>> 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.
>
> This is OK, thanks.

Committed, thanks.
diff mbox

Patch

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