From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 7062 invoked by alias); 1 Mar 2013 14:26:46 -0000 Received: (qmail 6727 invoked by uid 22791); 1 Mar 2013 14:26:39 -0000 X-SWARE-Spam-Status: No, hits=-4.5 required=5.0 tests=AWL,BAYES_00,KHOP_THREADED,RCVD_IN_DNSWL_NONE,RCVD_IN_HOSTKARMA_YE,SPF_SOFTFAIL X-Spam-Check-By: sourceware.org Received: from mtaout22.012.net.il (HELO mtaout22.012.net.il) (80.179.55.172) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Fri, 01 Mar 2013 14:26:33 +0000 Received: from conversion-daemon.a-mtaout22.012.net.il by a-mtaout22.012.net.il (HyperSendmail v2007.08) id <0MIZ00L00K32O100@a-mtaout22.012.net.il> for gdb-patches@sourceware.org; Fri, 01 Mar 2013 16:26:27 +0200 (IST) Received: from HOME-C4E4A596F7 ([87.69.4.28]) by a-mtaout22.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0MIZ00LSQK3Z6OC0@a-mtaout22.012.net.il>; Fri, 01 Mar 2013 16:26:24 +0200 (IST) Date: Fri, 01 Mar 2013 14:26:00 -0000 From: Eli Zaretskii Subject: Re: [PATCH 3/3] doc, record: document record changes In-reply-to: To: "Metzger, Markus T" Cc: jan.kratochvil@redhat.com, gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <83vc9burfw.fsf@gnu.org> References: <1361808917-16934-1-git-send-email-markus.t.metzger@intel.com> <1361808917-16934-4-git-send-email-markus.t.metzger@intel.com> <838v6bhttl.fsf@gnu.org> 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: 2013-03/txt/msg00018.txt.bz2 > From: "Metzger, Markus T" > CC: "jan.kratochvil@redhat.com" , > "gdb-patches@sourceware.org" > Date: Fri, 1 Mar 2013 14:06:23 +0000 > > > > +"record function-call-history" prints the names of the functions > > > +from instructions stored in the execution log. > > > > "prints the names of the functions called by instructions in the > > execution log" > > I'm not sure whether "called" is the right term. The algorithm walks over > all instructions and collects the functions from which these instructions > originated. > > Example: > > 1 void foo (void) > 2 { > 3 ... > 4 bar (); > 5 ... > 6 } > > When we record the execution of foo, there will be instructions for the > first ..., then instructions for bar, and then instructions for the second .... > > The "record function-call-history" will print: > foo.c:1-4 foo (void) > bar.c:8-12 bar (void) > foo.c:5-6 foo (void This indicates that "record function-execution-history" might be a better name. But in any case, weren't 'bar' and 'foo' called in this example? Your original text, "prints the names of the functions from instructions", is confusing, since instructions don't store function names, they store addresses and numbers. > > > +@kindex show record full memory-query > > > +@item show record full memory-query > > > > I think it is good enough to have only one "@kindex set record" and > > one "@kindex show record" entry (which you already have at the > > beginning of this description), without the entries that advertise the > > rest of the command arguments. These varieties are all described > > together, so the multitude of index entries does not have any useful > > effect, it just bloats the index. > > I just renamed the text for existing indices. Do you still want me to > merge them? Can you give one example of such renaming? I'm not sure I understand what you did. > > > +@item record function-call-history > > > +Print function names for instructions stored in the recorded execution > > > +log. Prints one line for each sequence of instructions that is > > > +correlated to the same function. > > > > Isn't the last sentence equivalent to saying > > > > Prints one line for each function call in the execution log. > > > > ? If it is equivalent, I think my suggested wording is more clear and > > less technical. > > See above. Given the example (which I think it would be good to have in the manual), I suggest this wording instead: Prints one line for each sequence of instructions that all belong to the same function.