From: Joel Brobecker <brobecker@gnat.com>
Date: Mon, 28 Jun 2010 19:54:04 +0000 (+0000)
Subject: Document the GDB python directory.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=9279c692c1e31c527d29493a9d96ea19507ee01b;p=binutils-gdb.git

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.
---

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index bf4f918e517..4341e7209d7 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,7 @@
+2010-06-28  Joel Brobecker  <brobecker@adacore.com>
+
+	* NEWS: Add entry announcing the python directory.
+
 2010-06-28  Tom Tromey  <tromey@redhat.com>
 
 	* dwarf2read.c (read_structure_type): Allocate null cleanup later.
diff --git a/gdb/NEWS b/gdb/NEWS
index b286f1c0cb6..17cd3cb4f9e 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -132,6 +132,12 @@ is now deprecated.
 
 * Python scripting
 
+** GDB now provides a new directory location, called the python directory,
+   where Python scripts written for GDB can be installed.  The location
+   of that directory is <data-directory>/python, where <data-directory>
+   is the GDB data directory.  For more details, see section `Scripting
+   GDB using Python' in the manual.
+
 ** The GDB Python API now has access to breakpoints, symbols, symbol
    tables, program spaces, and frame's code blocks.  Additionally, GDB
    Parameters can now be created from the API, and manipulated via
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 47aa02dd456..e2130b7f0c5 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 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.