summaryrefslogtreecommitdiff
path: root/gdb/doc/gdb.texinfo
diff options
context:
space:
mode:
authorJoel Brobecker <brobecker@gnat.com>2010-06-28 19:54:03 +0000
committerJoel Brobecker <brobecker@gnat.com>2010-06-28 19:54:03 +0000
commit599fd48f1280e7b66fcae4ea304b2e2f0e32aded (patch)
tree2cdbef0d1957212d2644dd940ab86e8d12ab5af1 /gdb/doc/gdb.texinfo
parentf7b6ca434c1ca8b8d3a52df9745c55db35e4a61c (diff)
downloadgdb-599fd48f1280e7b66fcae4ea304b2e2f0e32aded.tar.gz
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/gdb.texinfo')
-rw-r--r--gdb/doc/gdb.texinfo12
1 files changed, 12 insertions, 0 deletions
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 2ea14368001..aac79f53c09 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.