Document ByteIOContext and URLContext change rules.

Originally committed as revision 11286 to svn://svn.ffmpeg.org/ffmpeg/trunk

1 files changed, 14 insertions, 0 deletions

diff --git a/libavformat/avio.h b/libavformat/avio.h
index 66f90d935c..0d90e3b945 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -29,6 +29,13 @@ typedef int64_t offset_t;
 
 /* unbuffered I/O */
 
+/**
+ * URL Context.
+ * New fields can be added to the end with minor version bumps.
+ * Removial, reordering and changes to existing fields require a Major
+ * version bump.
+ * sizeof(URLContext) must not be used outside libav*
+ */
 struct URLContext {
     struct URLProtocol *prot;
     int flags;
@@ -135,6 +142,13 @@ URLProtocol *av_protocol_next(URLProtocol *p);
 
 int register_protocol(URLProtocol *protocol);
 
+/**
+ * Bytestream IO Context.
+ * New fields can be added to the end with minor version bumps.
+ * Removial, reordering and changes to existing fields require a Major
+ * version bump.
+ * sizeof(ByteIOContext) must not be used outside libav*
+ */
 typedef struct {
     unsigned char *buffer;
     int buffer_size;