From: Andrew Burgess <aburgess@redhat.com>
To: gdb-patches@sourceware.org
Cc: Andrew Burgess <aburgess@redhat.com>
Subject: [PUSHED 2/3] gdb/doc: make use of group/end group in 'info pretty-printers' example
Date: Thu, 19 May 2022 15:24:33 +0100 [thread overview]
Message-ID: <62ec8e6dad018082e33e7dcb0633f28332f3520c.1652970188.git.aburgess@redhat.com> (raw)
In-Reply-To: <cover.1652970188.git.aburgess@redhat.com>
The 'info pretty-printers' example is pretty long and consists of many
commands and their output.
Currently, when the pdf manual is generated this example spans a
page-break, with the page-break falling part way through some example
output from GDB.
This commit breaks up the example using @group .... @end group, within
each group is a single GDB command and all its output.
Now, when the pdf manual is created, the page-break is placed after
the output of one GDB command, and before the subsequent command, this
looks much nicer.
---
gdb/doc/gdb.texinfo | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 68f7aba8d7d..76fc548fc84 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -12075,6 +12075,7 @@
@code{bar1} and @code{bar2}.
@smallexample
+@group
(gdb) info pretty-printer
library1.so:
foo
@@ -12082,11 +12083,15 @@
bar
bar1
bar2
+@end group
+@group
(gdb) info pretty-printer library2
library2.so:
bar
bar1
bar2
+@end group
+@group
(gdb) disable pretty-printer library1
1 printer disabled
2 of 3 printers enabled
@@ -12097,6 +12102,8 @@
bar
bar1
bar2
+@end group
+@group
(gdb) disable pretty-printer library2 bar;bar1
1 printer disabled
1 of 3 printers enabled
@@ -12105,6 +12112,8 @@
bar
bar1 [disabled]
bar2
+@end group
+@group
(gdb) disable pretty-printer library2 bar
1 printer disabled
0 of 3 printers enabled
@@ -12115,6 +12124,7 @@
bar [disabled]
bar1 [disabled]
bar2
+@end group
@end smallexample
Note that for @code{bar} the entire printer can be disabled,
--
2.25.4
next prev parent reply other threads:[~2022-05-19 14:24 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-18 13:35 [PATCH] Fix inconsistent input/output of example Nikolaos Chatzikonstantinou
2022-05-18 15:30 ` Andrew Burgess
2022-05-18 21:14 ` Nikolaos Chatzikonstantinou
2022-05-19 14:24 ` [PUSHED 0/3] " Andrew Burgess
2022-05-19 14:24 ` [PUSHED 1/3] gdb/doc: fix inconsistent info pretty-printer example Andrew Burgess
2022-05-19 14:24 ` Andrew Burgess [this message]
2022-05-19 14:24 ` [PUSHED 3/3] gdb/doc: use @value{GDBP} in 'info pretty-printer' example Andrew Burgess
2022-05-19 15:54 ` [PUSHED 0/3] Re: [PATCH] Fix inconsistent input/output of example Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=62ec8e6dad018082e33e7dcb0633f28332f3520c.1652970188.git.aburgess@redhat.com \
--to=aburgess@redhat.com \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).