From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 6266 invoked by alias); 9 Aug 2011 15:51:57 -0000 Received: (qmail 6256 invoked by uid 22791); 9 Aug 2011 15:51:56 -0000 X-SWARE-Spam-Status: No, hits=-0.3 required=5.0 tests=AWL,BAYES_40,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; Tue, 09 Aug 2011 15:51:42 +0000 Received: from conversion-daemon.a-mtaout21.012.net.il by a-mtaout21.012.net.il (HyperSendmail v2007.08) id <0LPO00C003XJ0C00@a-mtaout21.012.net.il> for gdb-patches@sourceware.org; Tue, 09 Aug 2011 18:51:40 +0300 (IDT) Received: from HOME-C4E4A596F7 ([84.228.94.185]) by a-mtaout21.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0LPO00BJ1422T8A0@a-mtaout21.012.net.il>; Tue, 09 Aug 2011 18:51:40 +0300 (IDT) Date: Tue, 09 Aug 2011 15:51:00 -0000 From: Eli Zaretskii Subject: Re: [PATCH 7/7] Add documentation. In-reply-to: <1312903509-25132-8-git-send-email-sanjoy@playingwithpointers.com> To: Sanjoy Das Cc: gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <83ei0uzipf.fsf@gnu.org> References: <1312903509-25132-1-git-send-email-sanjoy@playingwithpointers.com> <1312903509-25132-8-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/msg00200.txt.bz2 > From: Sanjoy Das > Cc: Sanjoy Das > Date: Tue, 9 Aug 2011 20:55:09 +0530 > > +@node Custom Debug Info > +@section Custom Debug Info Please add a couple of @cindex entries here for the subjects of this section. > +A mentioned Probably meant "as mentioned" here. > readers can be loaded using the @code{load-jit-reader} > +command. Executing @code{load-jit-reader foo} will have @value{GDBN} > +try to load @code{foo.so} @file{foo.so} Btw, is the .so extension hard-coded? That is, does this feature support only Posix-style shared libraries, or Windows-style as well? > from @code{$libdir/gdb} where @code{libdir} @file{@var{libdir}/gdb} "libdir" is a place-holder, so it should be in @var. > +is the library directory for the system (usually something like > +@code{/usr/local/lib}). @file{/usr/local/lib} > +further interaction is required from the user's side. The current > +reader can be unloaded by executing @code{unload-jit-reader}, Please describe the commands in the format we use for all the other commands, including @kindex entries etc. > after > +which a new reader may be loaded, using @code{load-jit-reader} as > +usual. Does this mean only one reader can be loaded at any given time? If so, this should be said explicitly. What happens if I try to load another one without unloading first? > +As mentioned, a reader is essentially a shared object conforming to a > +certain ABI. This ABI is described in @file{jit-reader.h}. jit-reader.h or jit-reader.h.in? The previous section used the latter. > +@value{GDBN}), in @code{$includedir/gdb} where @code{$includedir} is > +the system include directory. @file{@var{includedir}/gdb} and @var{includedir} > +Readers need to be released under a GPL compatible license. A reader > +can be declared released under such a license by placing the macro ^^^^^^^^^^^^^^^^^ "declared as released", probably. > +those object files. @code{struct gdb_unwind_callbacks} has callbacks ^^ Need two spaces here. > +to read registers off the current frame and to write out the values of > +the registers in the previous frame. Both have a callback ^^ Likewise. Thanks.