This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH] Improve the fetch/store of general-purpose and floating-point PowerPC registers
- From: Joel Brobecker <brobecker at adacore dot com>
- To: S?rgio Durigan J?nior <sergiodj at linux dot vnet dot ibm dot com>
- Cc: luisgpm at linux dot vnet dot ibm dot com, gdb-patches at sourceware dot org, Mark Kettenis <mark dot kettenis at xs4all dot nl>
- Date: Tue, 28 Apr 2009 21:05:06 -0700
- Subject: Re: [PATCH] Improve the fetch/store of general-purpose and floating-point PowerPC registers
- References: <1223404355.7030.20.camel@miki> <1224184035.27672.64.camel@miki> <1231289020.2026.3.camel@miki> <200901070955.n079twBj014790@brahms.sibelius.xs4all.nl> <1231344540.2026.7.camel@miki> <1231436749.2026.19.camel@miki> <1231503988.12849.6.camel@gargoyle> <1232558849.6328.23.camel@miki> <20090428200725.GC31821@adacore.com> <1240953172.2392.1.camel@miki>
> > Sorry for the delay in reviewing this. I don't know much about ptrace
> > except as a user, but this seems to make sense. The only request I have
> > is for you to write a small comment describing each new function you
> > introduce. The patch is OK with those changes.
>
> So the request is about the ChangeLog, right? Ok, I'll resubmit it with
> the modifications as soon as possible.
Actually, no. The comments are for the functions themselves. We're
trying to make sure that every new function gets in with some
documentation of what it does. It doesn't have to be very long,
but sometimes writing what the return value is about is very useful.
For instance, I remember that some of your functions will return
zero if the operation failed, I think. That's an interesting piece
of information to put in the documentation. When the function is
obvious, or when it implements a routine that's part of the gdbarch
vector, then what we've been doing, lately, is just say "Implements
the "bla_bla_bla" gdbarch method." or somesuch (we try not to repeat
the documentation to avoid maintenance issues).
--
Joel