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.
This commit is contained in:
Nick Clifton 2017-12-15 18:55:39 +00:00
parent 68f81d6019
commit fc076a47fd
2 changed files with 12 additions and 4 deletions

View File

@ -1,3 +1,10 @@
2017-12-15 Nick Clifton <nickc@redhat.com>
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 <nickc@redhat.com>
* cpu-mt.c: Update address of FSF in copyright notice.

View File

@ -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 *