This is the mail archive of the
binutils-cvs@sourceware.org
mailing list for the binutils project.
[binutils-gdb] Update documentation regarding the bfd returned by bfd_openr_next_archived_file
- From: Nick Clifton <nickc at sourceware dot org>
- To: bfd-cvs at sourceware dot org
- Date: 15 Dec 2017 18:56:30 -0000
- Subject: [binutils-gdb] Update documentation regarding the bfd returned by bfd_openr_next_archived_file
https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=fc076a47fd716ca75447d432251abc67a19ef908
commit fc076a47fd716ca75447d432251abc67a19ef908
Author: Nick Clifton <nickc@redhat.com>
Date: Fri Dec 15 18:55:39 2017 +0000
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.
Diff:
---
bfd/ChangeLog | 7 +++++++
bfd/archive.c | 9 +++++----
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/bfd/ChangeLog b/bfd/ChangeLog
index debd663..4d4b10f 100644
--- a/bfd/ChangeLog
+++ b/bfd/ChangeLog
@@ -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.
diff --git a/bfd/archive.c b/bfd/archive.c
index 021ed8b..a0ffb7b 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 *