public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Keith Seitz <keiths@redhat.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH v4 9/9] Explicit locations: documentation updates
Date: Thu, 07 May 2015 18:55:00 -0000	[thread overview]
Message-ID: <83zj5gp69e.fsf@gnu.org> (raw)
In-Reply-To: <20150507180607.19629.20793.stgit@valrhona.uglyboxes.com>

> From: Keith Seitz <keiths@redhat.com>
> Date: Thu, 07 May 2015 11:06:07 -0700
> 
> This patch adds documentation for explicit locations to both the
> User Manual and gdb's online help system.

Thanks.

> 	(Specifying a Location): Rewrite.  Add explanations for each
> 	location type.

You also added new subsections there.

> 	(Source and Machine Code): Use "location(s)" instead of
> 	"linespec(s)".
> 	(C Preprocessor Macros): Likewise.
> 	(Create and Delete Tracepoints): Likewise.
> 	(Extensions for Ada Tasks): Likewise.

Can we please avoid all those "likewises" and instead use the
GNU-standard ChangeLog syntax, like this:

	(Source and Machine Code, C Preprocessor Macros)
	(Create and Delete Tracepoints, Extensions for Ada Tasks): Use
	"location(s)" ...

> +@subsection Linespec Locations
> +@anchor{Linespec Locations}

I'd prefer not having subsections without @nodes.  It will require
adding a menu in the parent node, but will free you from the need to
define an @anchor.  More importantly, it will make these subsections
more easily reachable in the Info reader.

> +@dfn{Address locations} indicate a specific program address.  They have
> +the generalized form *@var{address}.
                        ^^^^^^^^^^^^^^
This should be in @code, as in @code{*@var{address}}.

> +@item address location
> +An address location, *@var{address}.  @xref{Address Locations}.

Same here.

OK with these fixed.

      reply	other threads:[~2015-05-07 18:55 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-07 18:05 [PATCH v4 0/9] Locations API Keith Seitz
2015-05-07 18:05 ` [PATCH v4 2/9] Explicit locations: introduce new struct event_location-based API Keith Seitz
2015-05-17 20:54   ` Doug Evans
2015-05-19 20:41     ` Keith Seitz
2015-05-19 22:16       ` Pedro Alves
2015-05-07 18:06 ` [PATCH v4 7/9] Explicit locations: add UI features for CLI Keith Seitz
2015-05-18  6:55   ` Doug Evans
2015-05-19 20:41     ` Keith Seitz
2015-05-27  4:27       ` Doug Evans
2015-05-07 18:06 ` [PATCH v4 5/9] Explicit locations: introduce probe locations Keith Seitz
2015-05-18  5:49   ` Doug Evans
2015-05-07 18:06 ` [PATCH v4 1/9] Explicit locations: rename "address string"/"addr_string" to "location" Keith Seitz
2015-05-17 20:10   ` Doug Evans
2015-05-07 18:06 ` [PATCH v4 4/9] Explicit locations: introduce address locations Keith Seitz
2015-05-18  5:45   ` Doug Evans
2015-05-07 18:06 ` [PATCH v4 3/9] Explicit locations: use new location API Keith Seitz
2015-05-18  5:21   ` Doug Evans
2015-05-19 21:30     ` Keith Seitz
2015-05-07 18:06 ` [PATCH v4 8/9] Explicit locations: MI support for explicit locations Keith Seitz
2015-05-18  7:16   ` Doug Evans
2015-05-07 18:06 ` [PATCH v4 6/9] Explicit locations: introduce " Keith Seitz
2015-05-18  6:13   ` Doug Evans
2015-05-18 20:14     ` Keith Seitz
2015-05-19 22:09       ` Pedro Alves
2015-05-19 22:12         ` Keith Seitz
2015-05-19 22:15           ` Pedro Alves
2015-05-19 22:20             ` Keith Seitz
2015-05-21 19:34               ` [PATCH v5] Explicit locations: add UI features for CLI Keith Seitz
2015-05-27  4:43               ` [PATCH v4 6/9] Explicit locations: introduce explicit locations Doug Evans
2015-05-27 11:36                 ` Matt Rice
2015-05-30 15:17                   ` Matt Rice
2015-05-07 18:13 ` [PATCH v4 9/9] Explicit locations: documentation updates Keith Seitz
2015-05-07 18:55   ` Eli Zaretskii [this message]

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=83zj5gp69e.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=keiths@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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).