From fc076a47fd716ca75447d432251abc67a19ef908 Mon Sep 17 00:00:00 2001 From: Nick Clifton Date: Fri, 15 Dec 2017 18:55:39 +0000 Subject: [PATCH] Update documentation regarding the bfd returned by bfd_openr_next_archived_file PR 22571 * archive.c (bfd_openr_next_archived_file): Extend the documentation to note that it is necessary to call bfd_check_format on the rrturned bfd before using it. --- bfd/ChangeLog | 7 +++++++ bfd/archive.c | 9 +++++---- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/bfd/ChangeLog b/bfd/ChangeLog index debd6638d4c..4d4b10f278a 100644 --- a/bfd/ChangeLog +++ b/bfd/ChangeLog @@ -1,3 +1,10 @@ +2017-12-15 Nick Clifton + + PR 22571 + * archive.c (bfd_openr_next_archived_file): Extend the + documentation to note that it is necessary to call + bfd_check_format on the rrturned bfd before using it. + 2017-12-14 Nick Clifton * cpu-mt.c: Update address of FSF in copyright notice. diff --git a/bfd/archive.c b/bfd/archive.c index 021ed8b3566..a0ffb7b6056 100644 --- a/bfd/archive.c +++ b/bfd/archive.c @@ -764,10 +764,11 @@ SYNOPSIS DESCRIPTION Provided a BFD, @var{archive}, containing an archive and NULL, open an input BFD on the first contained element and returns that. - Subsequent calls should pass - the archive and the previous return value to return a created - BFD to the next contained element. NULL is returned when there - are no more. + Subsequent calls should pass the archive and the previous return + value to return a created BFD to the next contained element. NULL + is returned when there are no more. + Note - if you want to process the bfd returned by this call be + sure to call bfd_check_format() on it first. */ bfd * -- 2.30.2