From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 3128 invoked by alias); 20 Aug 2011 08:34:53 -0000 Received: (qmail 2828 invoked by uid 22791); 20 Aug 2011 08:34:51 -0000 X-SWARE-Spam-Status: No, hits=0.5 required=5.0 tests=AWL,BAYES_50,RCVD_IN_DNSWL_NONE,SPF_SOFTFAIL X-Spam-Check-By: sourceware.org Received: from mtaout21.012.net.il (HELO mtaout21.012.net.il) (80.179.55.169) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Sat, 20 Aug 2011 08:34:36 +0000 Received: from conversion-daemon.a-mtaout21.012.net.il by a-mtaout21.012.net.il (HyperSendmail v2007.08) id <0LQ700500WOBRM00@a-mtaout21.012.net.il> for gdb-patches@sourceware.org; Sat, 20 Aug 2011 11:33:24 +0300 (IDT) Received: from HOME-C4E4A596F7 ([77.126.49.191]) by a-mtaout21.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0LQ700GLDX3M2X4F@a-mtaout21.012.net.il>; Sat, 20 Aug 2011 11:33:24 +0300 (IDT) Date: Sat, 20 Aug 2011 08:34:00 -0000 From: Eli Zaretskii Subject: Re: [PATCH 6/6] Documentation. In-reply-to: <1313821635-22137-7-git-send-email-sanjoy@playingwithpointers.com> To: Sanjoy Das Cc: gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <83k4a8qy7c.fsf@gnu.org> References: <1313821635-22137-1-git-send-email-sanjoy@playingwithpointers.com> <1313821635-22137-7-git-send-email-sanjoy@playingwithpointers.com> X-IsSubscribed: yes Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2011-08/txt/msg00393.txt.bz2 > From: Sanjoy Das > Cc: Sanjoy Das > Date: Sat, 20 Aug 2011 11:57:15 +0530 > > +such a parser. More specific details can be found in the file > +@file{gdb/jit-reader.h.in}. The file name needs an update, I think. > +The reader is implemented as a shared object. Two new @value{GDBN} > +commands, @code{load-jit-reader} and @code{unload-jit-reader} are > +added, to be used to load and unload the readers from a preconfigured ^^^^^ "provided" is better, especially if the manual is read a year from now ;-) > +@node Using Readers > +@subsection Using Readers > +@kindex load-jit-reader > +@kindex unload-jit-reader > + > +Readers can be loaded and unloaded using the @code{load-jit-reader} > +and @code{unload-jit-reader} commands. > + > +@table @code > +@kindex load-jit-reader > +@item load-jit-reader @var{reader-name} Please leave only one @kindex, the one that's immediately before the command description. In general, it is not useful to have identical or very similar index entries that point to the same page in the document. They just inflate the index without adding any benefits for the reader who uses the index to quickly find the information she is after. > +in @value{GDBN} reporting an error. A new JIT reader can be loaded by > +first unloading the current one using @code{unload-jit-reader} and > +then running @code{load-jit-reader}. ^^^^^^^ "invoking" is better here. > +@node Writing Readers > +@subsection Writing Readers Suggest a less general name like "Writing JIT Readers". > +@findex gdb_init_reader > + > +@smallexample Please don't leave an empty line between the index entries and the text they index. > +@cindex @code{struct gdb_reader_funcs} > + > +@code{struct gdb_reader_funcs} contains a set of pointers to callback Same here. > +reader is being unloaded (@code{destroy}). The struct looks like this ^^ Need two spaces here. Okay with those changes. Thanks.