public inbox for gdb-cvs@sourceware.org
help / color / mirror / Atom feed
From: Andrew Burgess <aburgess@sourceware.org>
To: gdb-cvs@sourceware.org
Subject: [binutils-gdb] gdb/doc: make use of group/end group in 'info pretty-printers' example
Date: Thu, 19 May 2022 14:22:27 +0000 (GMT)	[thread overview]
Message-ID: <20220519142227.3B07A383F843@sourceware.org> (raw)

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=62ec8e6dad018082e33e7dcb0633f28332f3520c

commit 62ec8e6dad018082e33e7dcb0633f28332f3520c
Author: Andrew Burgess <aburgess@redhat.com>
Date:   Thu May 19 15:13:22 2022 +0100

    gdb/doc: make use of group/end group in 'info pretty-printers' example
    
    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.

Diff:
---
 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 @@ another from library2.so named @code{bar} that prints two types of objects,
 @code{bar1} and @code{bar2}.
 
 @smallexample
+@group
 (gdb) info pretty-printer
 library1.so:
   foo
@@ -12082,11 +12083,15 @@ library2.so:
   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 @@ library2.so:
   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 @@ library2.so:
   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 @@ library2.so:
   bar [disabled]
     bar1 [disabled]
     bar2
+@end group
 @end smallexample
 
 Note that for @code{bar} the entire printer can be disabled,


                 reply	other threads:[~2022-05-19 14:22 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20220519142227.3B07A383F843@sourceware.org \
    --to=aburgess@sourceware.org \
    --cc=gdb-cvs@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).