Go to file
Andrew Burgess 48883ade64 gdb/doc: update syntax of -data-disassemble command arguments
The argument documentation for -data-disassemble 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 specifications 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.

However, the 'Notation and Terminology' section only describes two
uses for parenthesis: '( GROUP )*' and '( GROUP )+', in the first case
GROUP is repeated zero or more times, and in the second GROUP is
repeated 1 or more times.

Neither of those exactly describe what I want, which is GROUP must
appear exactly once.  I propose to extend 'Notation and Terminology'
to include '( GROUP )' which means that GROUP should appear exactly
once.

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.
2022-10-02 11:58:28 +01:00
bfd Automatic date update in version.in 2022-10-02 00:00:18 +00:00
binutils objcopy: avoid "shadowing" of remove() function name 2022-09-30 10:55:02 +02:00
config egrep in binutils 2022-09-28 13:37:31 +09:30
contrib
cpu Add markers for 2.39 branch 2022-07-08 10:41:07 +01:00
elfcpp Add gold support for --package-metadata option. 2022-08-04 17:37:32 -07:00
etc
gas RISC-V: Relax "fmv.[sdq]" requirements 2022-09-30 15:10:27 +00:00
gdb gdb/doc: update syntax of -data-disassemble command arguments 2022-10-02 11:58:28 +01:00
gdbserver Renenerate {gdb,gdbserver}/configure 2022-09-28 13:06:06 +01:00
gdbsupport gdbsupport: move fileio_errno_to_host to fileio.{h,cc} and rename 2022-09-21 14:11:03 -04:00
gnulib
gold egrep in binutils 2022-09-28 13:37:31 +09:30
gprof Add -B to the help output from gprof, and add suitable documentation. 2022-09-29 13:12:37 +01:00
gprofng gprofng: fix cppcheck warnings 2022-09-29 22:00:02 -07:00
include LoongArch: Update ELF e_flags handling according to specification. 2022-09-30 14:00:47 +08:00
intl egrep in binutils 2022-09-28 13:37:31 +09:30
ld RISC-V: re-arrange opcode table for consistent alias handling 2022-09-30 10:19:00 +02:00
libbacktrace
libctf libctf: Add ZSTD_LIBS to LIBS so that ac_cv_libctf_bfd_elf can be true 2022-09-26 20:41:42 -07:00
libdecnumber
libiberty Add markers for 2.39 branch 2022-07-08 10:41:07 +01:00
opcodes RISC-V: Relax "fmv.[sdq]" requirements 2022-09-30 15:10:27 +00:00
readline
sim sim: Link ZSTD_LIBS 2022-09-27 11:42:32 -07:00
texinfo
zlib Regenerate with automake-1.15.1 2022-07-09 20:10:47 +09:30
.cvsignore
.editorconfig
.gitattributes binutils-gdb/git: highlight whitespace errors in source files 2022-07-25 14:35:41 +01:00
.gitignore
ar-lib
ChangeLog Maintainer mode: wrong gettext version? 2022-09-08 10:03:04 +01:00
compile
config-ml.in
config.guess
config.rpath
config.sub
configure binutils, gdb: support zstd compressed debug sections 2022-09-26 19:50:13 -07:00
configure.ac binutils, gdb: support zstd compressed debug sections 2022-09-26 19:50:13 -07:00
COPYING
COPYING3
COPYING3.LIB
COPYING.LIB
COPYING.LIBGLOSS
COPYING.NEWLIB
depcomp
djunpack.bat
install-sh
libtool.m4
lt~obsolete.m4
ltgcc.m4
ltmain.sh
ltoptions.m4
ltsugar.m4
ltversion.m4
MAINTAINERS
Makefile.def
Makefile.in
Makefile.tpl
makefile.vms
missing
mkdep
mkinstalldirs
move-if-change
multilib.am
README
README-maintainer-mode Maintainer mode: wrong gettext version? 2022-09-08 10:03:04 +01:00
setup.com
src-release.sh
symlink-tree
test-driver
ylwrap

		   README for GNU development tools

This directory contains various GNU compilers, assemblers, linkers, 
debuggers, etc., plus their support routines, definitions, and documentation.

If you are receiving this as part of a GDB release, see the file gdb/README.
If with a binutils release, see binutils/README;  if with a libg++ release,
see libg++/README, etc.  That'll give you info about this
package -- supported targets, how to use it, how to report bugs, etc.

It is now possible to automatically configure and build a variety of
tools with one command.  To build all of the tools contained herein,
run the ``configure'' script here, e.g.:

	./configure 
	make

To install them (by default in /usr/local/bin, /usr/local/lib, etc),
then do:
	make install

(If the configure script can't determine your type of computer, give it
the name as an argument, for instance ``./configure sun4''.  You can
use the script ``config.sub'' to test whether a name is recognized; if
it is, config.sub translates it to a triplet specifying CPU, vendor,
and OS.)

If you have more than one compiler on your system, it is often best to
explicitly set CC in the environment before running configure, and to
also set CC when running make.  For example (assuming sh/bash/ksh):

	CC=gcc ./configure
	make

A similar example using csh:

	setenv CC gcc
	./configure
	make

Much of the code and documentation enclosed is copyright by
the Free Software Foundation, Inc.  See the file COPYING or
COPYING.LIB in the various directories, for a description of the
GNU General Public License terms under which you can copy the files.

REPORTING BUGS: Again, see gdb/README, binutils/README, etc., for info
on where and how to report problems.