This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH 5/9 v7] Introduce common-regcache.h


Doug Evans wrote:
> Gary Benson writes:
> > +/* Return the register cache associated with the thread specified
> > +   by PTID.  This function must be provided by the client.  */
> 
> Can you add a comment here explaining the ownership of the memory
> object returned?  E.g., is it cached "internally" to the function
> so that the caller doesn't have to free it?

That seems odd.  We don't document other similar functions this way:
I'm thinking GDB's get_current_arch, current_inferior, target_gdbarch,
or gdbserver's current_process, current_target_desc.  It seems the
pattern is to note if the caller must free the object and to remain
quiet otherwise.

How about I change the comment to "Return _a_pointer_to_ the register
cache..."?  (underlines for emphasis here).

Cheers,
Gary

-- 
http://gbenson.net/


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]