RE: [PATCH 3/3] doc, record: document record changes

["Metzger, Markus T" <markus dot t dot metzger at intel dot com>]

> -----Original Message-----
> From: Eli Zaretskii [mailto:eliz@gnu.org]
> Sent: Tuesday, February 26, 2013 6:24 PM
> To: Metzger, Markus T

Thanks for your review.

> [May I ask that you use your address fewer than 3 times in the headers?]

I reduced it by one.


> > +"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


> > +@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?


> > +@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.

Thanks,
Markus.
Intel GmbH
Dornacher Strasse 1
85622 Feldkirchen/Muenchen, Deutschland
Sitz der Gesellschaft: Feldkirchen bei Muenchen
Geschaeftsfuehrer: Christian Lamprechter, Hannes Schwaderer, Douglas Lusk
Registergericht: Muenchen HRB 47456
Ust.-IdNr./VAT Registration No.: DE129385895
Citibank Frankfurt a.M. (BLZ 502 109 00) 600119052