[1/2] Add objfile.username: improve docs for Objfile.filename
Commit Message
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
> 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.
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.
@@ -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
@@ -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