From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 23037 invoked by alias); 27 Jun 2010 18:15:14 -0000 Received: (qmail 23028 invoked by uid 22791); 27 Jun 2010 18:15:13 -0000 X-SWARE-Spam-Status: No, hits=-2.1 required=5.0 tests=AWL,BAYES_00,T_RP_MATCHES_RCVD X-Spam-Check-By: sourceware.org Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Sun, 27 Jun 2010 18:15:09 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id 43A492BAB94; Sun, 27 Jun 2010 14:15:08 -0400 (EDT) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id qhDzUC7Buw9J; Sun, 27 Jun 2010 14:15:08 -0400 (EDT) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id EE98C2BAB43; Sun, 27 Jun 2010 14:15:07 -0400 (EDT) Received: by joel.gnat.com (Postfix, from userid 1000) id 486CEF5894; Sun, 27 Jun 2010 11:14:48 -0700 (PDT) From: Joel Brobecker To: gdb-patches@sourceware.org Cc: Joel Brobecker Subject: [RFA/doco] Document the GDB python directory. Date: Sun, 27 Jun 2010 18:15:00 -0000 Message-Id: <1277662486-2260-1-git-send-email-brobecker@adacore.com> Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2010-06/txt/msg00621.txt.bz2 Hello, The following patch add NEWS & documentation for the new python directory: http://www.sourceware.org/ml/gdb-patches/2010-06/msg00565.html 2010-06-27 Joel Brobecker * NEWS: Add entry announcing the python directory. 2010-06-27 Joel Brobecker * gdb.texinfo (Python): Document what the python directory is and what its location is. (Basic Python): Document the gdb.PYTHONDIR constant. OK to commit? Thanks, -- Joel --- gdb/NEWS | 5 +++++ gdb/doc/gdb.texinfo | 12 ++++++++++++ 2 files changed, 17 insertions(+), 0 deletions(-) diff --git a/gdb/NEWS b/gdb/NEWS index 1e1ea39..3b64088 100644 --- a/gdb/NEWS +++ b/gdb/NEWS @@ -103,6 +103,11 @@ 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 /python, where + is the GDB data directory. + ** 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/gdb.texinfo b/gdb/doc/gdb.texinfo index cbd636f..d0e5a39 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] Evaluate @var{command}, a string, as a @value{GDBN} CLI command. -- 1.7.1