[FFmpeg-devel] [PATCH] avformat: Document urls a bit

[Michael Niedermayer]

From: Michael Niedermayer <michael at niedermayer.cc>

Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>
---
 libavformat/avformat.h |    9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 4964263..d3b3bf2 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -78,6 +78,15 @@
  * if its AVClass is non-NULL, and the protocols layer. See the discussion on
  * nesting in @ref avoptions documentation to learn how to access those.
  *
+ * @section urls
+ * URLs in libavformat are made of a protocol a ':' and a protocol specific string
+ * urls without a protocol and ':' used for local files are supported but
+ * deprecated. "file:" should be used for local files.
+ * It is important that the protocol string is not taken from untrusted soucres
+ * without checks.
+ * some protocols are quite powerfull, allowing access to local and remote files,
+ * parts of them, concatenations of them, local audio and video devices and so on.
+ *
  * @defgroup lavf_decoding Demuxing
  * @{
  * Demuxers read a media file and split it into chunks of data (@em packets). A
-- 
1.7.9.5