[FFmpeg-cvslog] avformat/avformat: Update AVInputFormat.read_packet documentation

[Andreas Rheinhardt]

ffmpeg | branch: master | Andreas Rheinhardt <andreas.rheinhardt at gmail.com> | Tue Jan  7 14:55:39 2020 +0100| [b55c6b8c40e09a1a8076bbc8b4a804801bec530c] | committer: Michael Niedermayer

avformat/avformat: Update AVInputFormat.read_packet documentation

Since bae8844e351, the packet is automatically unreferenced in
ff_read_packet() when an error is returned; but the documentation of
this of AVInputFormat.read_packet has not been updated accordingly.

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt at gmail.com>
Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=b55c6b8c40e09a1a8076bbc8b4a804801bec530c
---

 libavformat/avformat.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index d4d9a3b06e..9b9b634ec3 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -715,8 +715,7 @@ typedef struct AVInputFormat {
      * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
      * background thread).
      * @return 0 on success, < 0 on error.
-     *         When returning an error, pkt must not have been allocated
-     *         or must be freed before returning
+     *         Upon returning an error, pkt must be unreferenced by the caller.
      */
     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);