Patchwork [Committed] Python doc build fixes

login
register
mail settings
Submitter Tom Tromey
Date Oct. 9, 2018, 8 p.m.
Message ID <87y3b6c2l5.fsf@tromey.com>
Download mbox | patch
Permalink /patch/29685/
State New
Headers show

Comments

Tom Tromey - Oct. 9, 2018, 8 p.m.
>>>>> "Andreas" == Andreas Krebbel <krebbel@linux.ibm.com> writes:

Andreas> From: Andreas Krebbel <krebbel@linux.vnet.ibm.com>
Andreas> I've just committed this patch to fix doc build for me.

Thank you.  And, sorry about the breakage.

Andreas> 2018-10-08  Andreas Krebbel  <krebbel@linux.ibm.com>

Andreas> 	* python.texi (Inferior.Architecture): Add "@end defun". Rename
Andreas> 	ref target to "Unwinding Frames in Python".

I think you didn't commit the ChangeLog change.

Andreas> -particular frame (@pxref{Frames in Python}).
Andreas> +particular frame (@pxref{Unwinding Frames in Python}).

This was intended to link to the general information about gdb.Frame,
not to the node about how to write an unwinder, which seems less
relevant in context.

However, I typo'd the "in" -- it should have been "In".

I'm checking in the appended to change this to what was originally
intended.

Tom

commit 163cffefafb1d427ab46603d98bbfc45e813c9a0
Author: Tom Tromey <tom@tromey.com>
Date:   Tue Oct 9 13:57:10 2018 -0600

    Make @pxref for Inferior.architecture point to gdb.Frame documentation
    
    This fixes he @pxref in Inferior.architecture to point to the "Frames
    In Python" node, as originally intended; somewhat reverting an earlier
    build fix.  The initial patch had typod the "In".
    
    Tested by "make info".
    
    gdb/doc/ChangeLog
    2018-10-09  Tom Tromey  <tom@tromey.com>
    
            * python.texi (Inferiors In Python): Link to "Frames In Python",
            not "Unwinding Frames in Python".

Patch

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index c67798399f..0cab170456 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@ 
+2018-10-09  Tom Tromey  <tom@tromey.com>
+
+	* python.texi (Inferiors In Python): Link to "Frames In Python",
+	not "Unwinding Frames in Python".
+
 2018-10-09  Tom Tromey  <tom@tromey.com>
 
 	* gdb.texinfo (Configure Options): Update --enable-ubsan
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 2320be63dd..ff5fecea1b 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -2865,7 +2865,7 @@  Return the @code{gdb.Architecture} (@pxref{Architectures In Python})
 for this inferior.  This represents the architecture of the inferior
 as a whole.  Some platforms can have multiple architectures in a
 single address space, so this may not match the architecture of a
-particular frame (@pxref{Unwinding Frames in Python}).
+particular frame (@pxref{Frames In Python}).
 @end defun
 
 @findex Inferior.read_memory