[pushed] Minor fix to gdb.prompt documentation

Message ID 20191210225806.3D3D225BB4@gnutoolchain-gerrit.osci.io
State New
Headers show
Series
  • [pushed] Minor fix to gdb.prompt documentation
Related show

Commit Message

Simon Marchi (Code Review) Dec. 10, 2019, 10:58 p.m.
Sourceware to Gerrit sync has submitted this change.

Change URL: https://gnutoolchain-gerrit.osci.io/r/c/binutils-gdb/+/693
......................................................................

Minor fix to gdb.prompt documentation

I noticed that an example in the gdb.prompt documentation used the
wrong kind of quotes -- because it is code, it should use a plain
ASCII quotation mark.  I also slightly shortened the sample text here,
so it would more clearly fit on a single line.

gdb/doc/ChangeLog
2019-12-10  Tom Tromey  <tom@tromey.com>

	* python.texi (gdb.prompt): Use correct quotes in example.
	Shorten sample text.

Change-Id: I4153928c0d88001244ad410f3943c952a6ebfeb1
---
M gdb/doc/ChangeLog
M gdb/doc/python.texi
2 files changed, 7 insertions(+), 3 deletions(-)



-- 
Gerrit-Project: binutils-gdb
Gerrit-Branch: master
Gerrit-Change-Id: I4153928c0d88001244ad410f3943c952a6ebfeb1
Gerrit-Change-Number: 693
Gerrit-PatchSet: 2
Gerrit-Owner: Tom Tromey <tromey@sourceware.org>
Gerrit-Reviewer: Pedro Alves <palves@redhat.com>
Gerrit-MessageType: merged

Patch

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 9a70de3..57ad682 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@ 
+2019-12-10  Tom Tromey  <tom@tromey.com>
+
+	* python.texi (gdb.prompt): Use correct quotes in example.
+	Shorten sample text.
+
 2019-12-04  Andrew Burgess  <andrew.burgess@embecosm.com>
 
 	* doc/gdb.texinfo (GDB/MI Symbol Query): Add documentation of
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index ed73bbf..f807fb2 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -5937,13 +5937,12 @@ 
 For example:
 
 @smallexample
-substitute_prompt (``frame: \f,
-                   print arguments: \p@{print frame-arguments@}'')
+substitute_prompt ("frame: \f, args: \p@{print frame-arguments@}")
 @end smallexample
 
 @exdent will return the string:
 
 @smallexample
-"frame: main, print arguments: scalars"
+"frame: main, args: scalars"
 @end smallexample
 @end table