gdb: update the comment on string_to_event_location
authorAndrew Burgess <aburgess@redhat.com>
Tue, 7 Dec 2021 13:22:33 +0000 (13:22 +0000)
committerAndrew Burgess <aburgess@redhat.com>
Wed, 2 Feb 2022 16:27:36 +0000 (16:27 +0000)
commitb6e05abee333e1cf322efac82bd7032c9d6b0add
treebb861934524ef22935400634ed8c5d271e61fc09
parenta698397481825193bee128d13f0b232bf66980ce
gdb: update the comment on string_to_event_location

The comment on string_to_event_location is (I believe) out of date.
This commit fixes the two issues I see:

  1. This function can't return NULL any more.  The implementation
  calls string_to_explicit_location which can return NULL, but if this
  is the case we then call string_to_event_location_basic, which I
  don't believe can ever return NULL.

  2. I've removed the mention that the returned string is malloc'd,
  though this is true, now that we return a managed pointer, I believe
  the source of the memory allocation is irrelevant, and so, shouldn't
  be discussed in the header comment.

There should be no user visible changes after this commit.
gdb/location.h