From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
To: gdb-patches@sourceware.org
Cc: Andrew Burgess <aburgess@redhat.com>
Subject: [PATCH 7/9] gdb/doc: update syntax of -data-disassemble command arguments
Date: Thu, 23 Jun 2022 17:05:14 +0100 [thread overview]
Message-ID: <afff4383e739e1bdeb2a756bc51b62e71eed3d7e.1655999715.git.aburgess@redhat.com> (raw)
In-Reply-To: <cover.1655999715.git.aburgess@redhat.com>
The argument documentation looks like this:
-data-disassemble
[ -s @var{start-addr} -e @var{end-addr} ]
| [ -a @var{addr} ]
| [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ]
-- @var{mode}
However, I believe, according to the 'Notation and Terminology'
section, this means that the there are 3 optional location
specification argument groups for the command, followed by a
non-optional '-- mode'.
However, this is not true, one of the location specification must be
given, i.e. we can't choose to give NO location specification, which
is what the above implies.
I propose that we change this to instead be:
-data-disassemble
( -s @var{start-addr} -e @var{end-addr}
| -a @var{addr}
| -f @var{filename} -l @var{linenum} [ -n @var{lines} ] )
-- @var{mode}
By placing all the location specifications within '( ... )' we
indication that these are a group, from which one of the options,
separated by '|', must be selected.
This change is important because, in a later commit, I want to add
additional optional arguments to the -data-disassemble command, and
things start to get confusing with the original syntax.
---
gdb/doc/gdb.texinfo | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index b0624afce2f..ca9d29bd364 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -34384,9 +34384,9 @@
@smallexample
-data-disassemble
- [ -s @var{start-addr} -e @var{end-addr} ]
- | [ -a @var{addr} ]
- | [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ]
+ ( -s @var{start-addr} -e @var{end-addr}
+ | -a @var{addr}
+ | -f @var{filename} -l @var{linenum} [ -n @var{lines} ] )
-- @var{mode}
@end smallexample
--
2.25.4
next prev parent reply other threads:[~2022-06-23 16:09 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-23 16:05 [PATCH 0/9] Disassembler opcode display and text alignment Andrew Burgess via Gdb-patches
2022-06-23 16:05 ` [PATCH 1/9] gdb/doc: improve description of --data-disassemble opcodes output Andrew Burgess via Gdb-patches
2022-06-23 16:09 ` Eli Zaretskii via Gdb-patches
2022-06-29 12:54 ` Andrew Burgess via Gdb-patches
2022-06-23 16:05 ` [PATCH 2/9] gdb/testsuite: new test for -data-disassemble opcodes format Andrew Burgess via Gdb-patches
2022-06-23 16:05 ` [PATCH 3/9] gdb/disasm: read opcodes bytes with a single read_code call Andrew Burgess via Gdb-patches
2022-06-23 16:05 ` [PATCH 4/9] gdb: disassembler opcode display formatting Andrew Burgess via Gdb-patches
2022-06-23 16:14 ` Eli Zaretskii via Gdb-patches
2022-06-23 16:05 ` [PATCH 5/9] gdb: make gdb_disassembly_flag unsigned Andrew Burgess via Gdb-patches
2022-06-23 16:05 ` [PATCH 6/9] gdb/doc: fix column widths in MI compatibility table Andrew Burgess via Gdb-patches
2022-06-23 16:22 ` Eli Zaretskii via Gdb-patches
2022-06-30 9:39 ` Andrew Burgess via Gdb-patches
2022-06-23 16:05 ` Andrew Burgess via Gdb-patches [this message]
2022-06-23 16:21 ` [PATCH 7/9] gdb/doc: update syntax of -data-disassemble command arguments Eli Zaretskii via Gdb-patches
2022-06-30 10:18 ` Andrew Burgess via Gdb-patches
2022-06-30 10:46 ` Eli Zaretskii via Gdb-patches
2022-06-23 16:05 ` [PATCH 8/9] gdb/mi: some int to bool conversion Andrew Burgess via Gdb-patches
2022-06-23 16:05 ` [PATCH 9/9] gdb/mi: new options for -data-disassemble command Andrew Burgess via Gdb-patches
2022-06-23 16:34 ` Eli Zaretskii via Gdb-patches
2022-06-30 11:22 ` Andrew Burgess via Gdb-patches
2022-06-30 13:36 ` Eli Zaretskii via Gdb-patches
2022-07-25 18:28 ` [PATCH 0/9] Disassembler opcode display and text alignment Andrew Burgess via Gdb-patches
2022-09-05 14:11 ` Andrew Burgess via Gdb-patches
2022-09-21 16:41 ` Tom Tromey
2022-10-02 13:15 ` Andrew Burgess via Gdb-patches
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=afff4383e739e1bdeb2a756bc51b62e71eed3d7e.1655999715.git.aburgess@redhat.com \
--to=gdb-patches@sourceware.org \
--cc=aburgess@redhat.com \
/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