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 v5] Explicit locations: documentation updates


> From: Keith Seitz <keiths@redhat.com>
> Date: Tue, 19 May 2015 15:16:43 -0700
> 
> This patch adds documentation for explicit locations to both the
> User Manual and gdb's online help system.
> 
> gdb/ChangeLog:
> 
> 	* NEWS: Mention explicit locations.
> 	* breakpoint.c [LOCATION_HELP_STRING]: New macro.
> 	[BREAK_ARGS_HELP]: Use LOCATION_HELP_STRING.
> 	(_initialize_breakpoint): Update documentation for
> 	"clear", "break", "trace", "strace", "ftrace", and "dprintf".
> 
> gdb/doc/ChangeLog:
> 
> 	* gdb.texinfo (Thread-Specific Breakpoints, Printing Source Lines):
> 	Use "location(s)"instead of "linespec(s)".
> 	(Specifying a Location): Rewrite.
> 	Add subsections describing linespec, address, and explicit locations.
> 	Add node/menu for each subsection.
> 	(Source and Machine Code, C Preprocessor Macros)
> 	(Create and Delete Trace points)
> 	(Extensions for Ada Tasks): Use "location(s)" instead of "linespec(s)".
> 	(Continuing at a Different Address): Remove "linespec" examples.
> 	Add reference to "Specify a Location"
> 	(The -break-insert Command): Rewrite.  Add anchor.
> 	Add reference to appropriate manual section discussing locations.
> 	(The -dprintf-insert Command): Refer to -break-insert for
> 	specification of 'location'.
> 
> This patch is originally #9/9.
> 
> Differences from the last version:
> 
> 1. Changed anchors to nodes for new subections.
> 2. Added new subsection menu to parent node, Specify Location.
> 3. Added @code as requested/necessary.
> 4. Updated ChangeLog
> 
> [Eli, I know you pre-approved with fixes, but I'd appreciate one more
> look at this to double-check one more time.]

LGTM, with one comment:

> +@node Linespec Locations
> +@subsection Linespec Locations

Please add a @cindex entry here that's identical to the subsection
name, just without capitalization, like you did for the other 2
subsections you wrote.

Thanks.


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