Formatting of packet descriptions in GDB manual

Jim Blandy jimb@red-bean.com
Wed Nov 16 07:17:00 GMT 2005


Here's a patch that implements the formatting changes to the
description of the remote protocol packets we've been discussing on
gdb@.

This uses @code for the packet templates, even though in my last
message there I said I thought @samp was more appropriate; @code is
what I've got right now, and I didn't want to go and change everything
twice if the conclusion was that @code was better.  But you can see
what was done.

gdb/doc/ChangeLog:
2005-11-15  Jim Blandy  <jimb@redhat.com>

	* gdb.texinfo (Packets): Use @code for packet contents.  Drop
	summaries from packet @item lines; the same information appears
	immediately below in the description.  Delete paragraph breaks
	after packet @item commands, so that the description appears
	directly to the right of the packet prototype in the printed
	manual, if it fits.  Place spaces in packet prototypes between
	@vars and non-@var letters, and explain that they're just for
	formatting.  Use @dots{} instead of '...'.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: jimb.gdb-doc-remote-protocol-formatting.patch
Type: text/x-patch
Size: 41032 bytes
Desc: not available
URL: <http://sourceware.org/pipermail/gdb-patches/attachments/20051116/ca19afa7/attachment.bin>


More information about the Gdb-patches mailing list