diff mbox series

[FFmpeg-devel,01/11] avformat/avformat: Update AVInputFormat.read_packet documentation

Message ID 20200107135549.22581-1-andreas.rheinhardt@gmail.com
State Accepted
Headers show
Series [FFmpeg-devel,01/11] avformat/avformat: Update AVInputFormat.read_packet documentation
Related show

Checks

Context Check Description
andriy/ffmpeg-patchwork pending
andriy/ffmpeg-patchwork success Applied patch
andriy/ffmpeg-patchwork success Configure finished
andriy/ffmpeg-patchwork success Make finished
andriy/ffmpeg-patchwork success Make fate finished

Commit Message

Andreas Rheinhardt Jan. 7, 2020, 1:55 p.m. UTC
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@gmail.com>
---
 libavformat/avformat.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

Comments

Michael Niedermayer Jan. 14, 2020, 10:20 p.m. UTC | #1
On Tue, Jan 07, 2020 at 02:55:39PM +0100, Andreas Rheinhardt wrote:
> 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@gmail.com>
> ---
>  libavformat/avformat.h | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)

will apply

thx

[...]
diff mbox series

Patch

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);