diff mbox

[1/4,v1] Add xmethod documentation and NEWS entry

Message ID 20140603175723.GA16336@adacore.com
State Committed
Headers

Commit Message

Joel Brobecker June 3, 2014, 5:57 p.m. UTC 
  Hello!

> 2014-05-06  Siva Chandra Reddy  <sivachandra@google.com>
>         doc/
>         *  python.texi (Xmethods In Python, XMethod API)
>         (Writing an Xmethod): New nodes.
>         (Python API): New menu entries "Xmethods In Python",
>         "Xmethod API", "Writing an Xmethod".

[...]

> +@defun register_xmethod_matcher(locus, matcher, replace=False)
> +The @code{matcher} is registered with @code{locus}, replacing an
> +existing matcher with the same name as @code{matcher} if
> +@code{replace} is @code{True}.  @code{locus} can be a
> +@code{gdb.Objfile} object (@pxref{Objfiles In Python}), or a
> +@code{gdb.Progspace} object (@pxref{Program Spaces In Python}), or
                                       ^^^^^^^^^^^^^^^^^^^^^^^^

This reference was incorrect and caused the documentation build to fail.
I fixed it by pushing the attached commit.

gdb/doc/ChangeLog:

        * python.texi (Xmethod API): Fix reference to "Progspaces In
        Python".

Tested by rebuilding all documentation formats.
diff mbox

Patch

From 1e47491b33aac7447697c3cdeff0bbdbba5d58a0 Mon Sep 17 00:00:00 2001
From: Joel Brobecker <brobecker@adacore.com>
Date: Tue, 3 Jun 2014 10:39:03 -0700
Subject: [PATCH] gdb/doc/python.texi: Fix reference to "Progspaces In Python".

A recent change broke the documentation build due to a think-o
in a reference.  Fixed thusly.

gdb/doc/ChangeLog:

        * python.texi (Xmethod API): Fix reference to "Progspaces In
        Python".

Tested by rebuilding all documentation formats.
---
 gdb/doc/ChangeLog   | 5 +++++
 gdb/doc/python.texi | 2 +-
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 16a60f3..237c9a4 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@ 
+2014-06-03  Joel Brobecker  <brobecker@adacore.com>
+
+	* python.texi (Xmethod API): Fix reference to "Progspaces In
+	Python".
+
 2014-06-03  Siva Chandra Reddy  <sivachandra@google.com>
 
 	*  python.texi (Xmethods In Python, XMethod API)
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 1ba248b..2f1b71f 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -2322,7 +2322,7 @@  The @code{matcher} is registered with @code{locus}, replacing an
 existing matcher with the same name as @code{matcher} if
 @code{replace} is @code{True}.  @code{locus} can be a
 @code{gdb.Objfile} object (@pxref{Objfiles In Python}), or a
-@code{gdb.Progspace} object (@pxref{Program Spaces In Python}), or
+@code{gdb.Progspace} object (@pxref{Progspaces In Python}), or
 @code{None}.  If it is @code{None}, then @code{matcher} is registered
 globally.
 @end defun
-- 
1.9.1