aboutsummaryrefslogtreecommitdiff
path: root/gdb/doc
diff options
context:
space:
mode:
authorJoel Brobecker <brobecker@gnat.com>2010-06-28 19:54:04 +0000
committerJoel Brobecker <brobecker@gnat.com>2010-06-28 19:54:04 +0000
commit9279c692c1e31c527d29493a9d96ea19507ee01b (patch)
treec56d87beed6b63ec3eae352b166025c873edbdc9 /gdb/doc
parentd3f41bb17012c1c836b552009b71c428774ddeed (diff)
downloadgdb-9279c692c1e31c527d29493a9d96ea19507ee01b.zip
gdb-9279c692c1e31c527d29493a9d96ea19507ee01b.tar.gz
gdb-9279c692c1e31c527d29493a9d96ea19507ee01b.tar.bz2
Document the GDB python directory.
2010-06-27 Joel Brobecker <brobecker@adacore.com> * NEWS: Add entry announcing the python directory. 2010-06-27 Joel Brobecker <brobecker@adacore.com> * gdb.texinfo (Python): Document what the python directory is and what its location is. (Basic Python): Document the gdb.PYTHONDIR constant.
Diffstat (limited to 'gdb/doc')
-rw-r--r--gdb/doc/ChangeLog6
-rw-r--r--gdb/doc/gdb.texinfo12
2 files changed, 18 insertions, 0 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 47aa02d..e2130b7 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,9 @@
+2010-06-28 Joel Brobecker <brobecker@adacore.com>
+
+ * gdb.texinfo (Python): Document what the python directory is
+ and what its location is.
+ (Basic Python): Document the gdb.PYTHONDIR constant.
+
2010-06-25 Tom Tromey <tromey@redhat.com>
PR python/10808:
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 2ea1436..aac79f5 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -20089,6 +20089,13 @@ You can script @value{GDBN} using the @uref{http://www.python.org/,
Python programming language}. This feature is available only if
@value{GDBN} was configured using @option{--with-python}.
+@cindex python directory
+Python scripts used by @value{GDBN} should be installed in
+@file{@var{data-directory}/python}, where @var{data-directory} is
+the data directory as determined at @value{GDBN} startup (@pxref{Data Files}). This directory, known as the @dfn{python directory},
+is automatically added to the Python Search Path in order to allow
+the Python interpreter to locate all scripts installed at this location.
+
@menu
* Python Commands:: Accessing Python from @value{GDBN}.
* Python API:: Accessing @value{GDBN} from Python.
@@ -20199,6 +20206,11 @@ methods and classes added by @value{GDBN} are placed in this module.
@value{GDBN} automatically @code{import}s the @code{gdb} module for
use in all scripts evaluated by the @code{python} command.
+@findex gdb.PYTHONDIR
+@defvar PYTHONDIR
+A string containing the python directory (@pxref{Python}).
+@end defvar
+
@findex gdb.execute
@defun execute command [from_tty] [to_string]
Evaluate @var{command}, a string, as a @value{GDBN} CLI command.