This is the mail archive of the
mailing list for the GDB project.
Re: [PATCH 5/9 v7] Introduce common-regcache.h
- From: Gary Benson <gbenson at redhat dot com>
- To: Doug Evans <dje at google dot com>
- Cc: gdb-patches at sourceware dot org, Pedro Alves <palves at redhat dot com>
- Date: Thu, 11 Sep 2014 12:02:31 +0100
- Subject: Re: [PATCH 5/9 v7] Introduce common-regcache.h
- Authentication-results: sourceware.org; auth=none
- References: <1409320299-6812-1-git-send-email-gbenson at redhat dot com> <1409320299-6812-6-git-send-email-gbenson at redhat dot com> <21520 dot 37315 dot 16694 dot 677898 at ruffy2 dot mtv dot corp dot google dot com>
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
How about I change the comment to "Return _a_pointer_to_ the register
cache..."? (underlines for emphasis here).