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 --git a/bfd/ChangeLog b/bfd/ChangeLog
index debd6638d4c75290d564fca5f76b0c1f03572fc6..4d4b10f278aaa6af36d3edd0ed9a3299a397ce5f 100644 (file)
--- 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 021ed8b3566e6d3796035513ec253e9b3dbd0d2e..a0ffb7b60569322e25f7af2e0ce78a1b56e1009c 100644 (file)
--- 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 *