diff options
| author | Nick Clifton <nickc@redhat.com> | 2017-12-15 18:55:39 +0000 |
|---|---|---|
| committer | Nick Clifton <nickc@redhat.com> | 2017-12-15 18:55:39 +0000 |
| commit | fc076a47fd716ca75447d432251abc67a19ef908 (patch) | |
| tree | a3a7e026381157d235978831399a6b97a9a4a354 /bfd/archive.c | |
| parent | 68f81d60196eb201b209873cf53258f13b0046b9 (diff) | |
| download | binutils-gdb-fc076a47fd716ca75447d432251abc67a19ef908.tar.gz | |
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.
Diffstat (limited to 'bfd/archive.c')
| -rw-r--r-- | bfd/archive.c | 9 |
1 files changed, 5 insertions, 4 deletions
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 * |