This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH v4 9/9] Explicit locations: documentation updates


> 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.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]