From: Doug Evans <dje@google.com>
Date: Tue, 27 Jan 2015 18:03:15 +0000 (-0800)
Subject: Improve docs of objfile filename method.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=1b5493961ab1f65a3336b2178ba3d035a130f9f6;p=binutils-gdb.git

Improve docs of objfile filename method.

gdb/doc/ChangeLog:

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

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index a5d83298829..c5340a8e336 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@
+2015-01-27  Doug Evans  <dje@google.com>
+
+	* python.texi (Objfiles In Python) <Objfile.filename>: Improve docs.
+	* guile.texi (Objfiles In Guile) <objfile-filename>: Improve docs.
+
 2015-01-22  Jan Kratochvil  <jan.kratochvil@redhat.com>
 
 	* gdb.texinfo (Threads): Describe -ascending for thread apply all.
diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi
index 8355d9f027c..53e69f27960 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 b9a50d0d55e..ba0384114b2 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