Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Luis Machado <luis.machado@linaro.org>
Cc: gdb-patches@sourceware.org, Alan.Hayward@arm.com,
	catalin.marinas@arm.com, david.spickett@linaro.org
Subject: Re: [PATCH 21/23] Document new "x" and "print" memory tagging extensions
Date: Fri, 17 Jul 2020 17:31:18 +0300	[thread overview]
Message-ID: <83sgdqi56x.fsf@gnu.org> (raw)
In-Reply-To: <4ab5c0f4-26fd-94e2-d574-ec15aacc486b@linaro.org> (message from Luis Machado on Fri, 17 Jul 2020 11:20:33 -0300)

> From: Luis Machado <luis.machado@linaro.org>
> Cc: gdb-patches@sourceware.org, Alan.Hayward@arm.com,
>  catalin.marinas@arm.com, david.spickett@linaro.org
> Date: Fri, 17 Jul 2020 11:20:33 -0300
> 
> >> +The @code{print} and @code{x} commands will display tag information when
> > 
> > And here please add a cross-reference to the nodes that describe the
> > 'print' and 'x' commands.
> > 
> 
> I added "@cindex Data" (for print) and "@cindex Memory" (for x) locally.

Not @cindex, @xref.

> >> +The @code{print} command will automatically attempt to validate the logical
> >> +tag against the allocation tag for pointers and addresses, and will display
> >> +a message in case of failure.
> >> +
> >> +The @code{x} command has a @code{m} modifier.  When present, this modifier
> >> +will make the @code{x} command output allocation tag information for a given
> >> +memory region that is being examined.
> > 
> > These should be in the sections that describe these commands, not
> > here.  The idea is to have everything about each command in a single
> > place, and then point there via cross-references from related places.
> > 
> > Thanks.
> > 
> 
> That makes sense. I wanted to make it obvious that memory tagging 
> provided some extra functionality to "print" and "x".
> 
> I suppose I'll just remove these two blocks since their content is 
> already described in both commands, although with slightly different text.

OK.


  reply	other threads:[~2020-07-17 14:31 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-15 19:44 [PATCH 00/23] Memory Tagging Support + AArch64 Linux implementation Luis Machado
2020-07-15 19:44 ` [PATCH 01/23] New target methods for memory tagging support Luis Machado
2020-07-15 19:44 ` [PATCH 02/23] New gdbarch memory tagging hooks Luis Machado
2020-07-15 19:44 ` [PATCH 03/23] Add GDB-side remote target support for memory tagging Luis Machado
2020-07-15 19:44 ` [PATCH 04/23] Unit testing for GDB-side remote memory tagging handling Luis Machado
2020-07-15 19:44 ` [PATCH 05/23] GDBserver remote packet support for memory tagging Luis Machado
2020-07-15 19:44 ` [PATCH 06/23] Unit tests for gdbserver memory tagging remote packets Luis Machado
2020-07-15 19:44 ` [PATCH 07/23] Documentation for " Luis Machado
2020-07-17  5:54   ` Eli Zaretskii
2020-07-17 14:20     ` Luis Machado
2020-07-15 19:44 ` [PATCH 08/23] AArch64: Add MTE CPU feature check support Luis Machado
2020-07-15 19:44 ` [PATCH 09/23] AArch64: Add target description/feature for MTE registers Luis Machado
2020-07-15 19:45 ` [PATCH 10/23] AArch64: Add MTE register set support for GDB and gdbserver Luis Machado
2020-07-15 19:45 ` [PATCH 11/23] AArch64: Add MTE ptrace requests Luis Machado
2020-07-15 19:45 ` [PATCH 12/23] AArch64: Implement memory tagging target methods for AArch64 Luis Machado
2020-07-15 19:45 ` [PATCH 13/23] Refactor parsing of /proc/<pid>/smaps Luis Machado
2020-07-15 19:45 ` [PATCH 14/23] AArch64: Implement the memory tagging gdbarch hooks Luis Machado
2020-07-15 19:45 ` [PATCH 15/23] AArch64: Add unit testing for logical tag set/get operations Luis Machado
2020-07-15 19:45 ` [PATCH 16/23] AArch64: Report tag violation error information Luis Machado
2020-07-15 19:45 ` [PATCH 17/23] AArch64: Add gdbserver MTE support Luis Machado
2020-07-15 19:45 ` [PATCH 18/23] New mtag commands Luis Machado
2020-07-15 19:45 ` [PATCH 19/23] Documentation for the new " Luis Machado
2020-07-17  6:11   ` Eli Zaretskii
2020-07-17 14:20     ` Luis Machado
2020-07-17 14:29       ` Eli Zaretskii
2020-07-17 15:08         ` Luis Machado
2020-07-15 19:45 ` [PATCH 20/23] Extend "x" and "print" commands to support memory tagging Luis Machado
2020-07-15 19:45 ` [PATCH 21/23] Document new "x" and "print" memory tagging extensions Luis Machado
2020-07-17  6:16   ` Eli Zaretskii
2020-07-17 14:20     ` Luis Machado
2020-07-17 14:31       ` Eli Zaretskii [this message]
2020-07-15 19:45 ` [PATCH 22/23] Add NEWS entry Luis Machado
2020-07-17  6:18   ` Eli Zaretskii
2020-07-17 14:20     ` Luis Machado
2020-07-15 19:45 ` [PATCH 23/23] Add memory tagging testcases Luis Machado
2020-07-16 16:49 ` [PATCH 00/23] Memory Tagging Support + AArch64 Linux implementation Alan Hayward
2020-07-17 12:33   ` Luis Machado
2020-07-17 22:02 ` John Baldwin
2020-07-23 13:59   ` Luis Machado
2020-07-23 16:48     ` John Baldwin
2020-07-24 16:10       ` David Spickett
2020-07-23 14:59 ` Luis Machado

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=83sgdqi56x.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=Alan.Hayward@arm.com \
    --cc=catalin.marinas@arm.com \
    --cc=david.spickett@linaro.org \
    --cc=gdb-patches@sourceware.org \
    --cc=luis.machado@linaro.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