summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/mediactl/media-header.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-09 08:54:35 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-09 09:49:05 -0300
commitd2c6815031681fb69fa14c4b17845dccd3210ab1 (patch)
treeec234625bf24144bf060d0bcff93ce389d4171e8 /Documentation/media/uapi/mediactl/media-header.rst
parentfb6fc6c9ac66fe5d4a50905fd7f2dd14cd9e7ab9 (diff)
downloadop-kernel-dev-d2c6815031681fb69fa14c4b17845dccd3210ab1.zip
op-kernel-dev-d2c6815031681fb69fa14c4b17845dccd3210ab1.tar.gz
[media] doc-rst: add media.h header to media contrller
Adding the header file is interesting for several reasons: 1) It makes MC documentation consistend with other parts; 2) The header file can be used as a quick index to all API elements; 3) The cross-reference check helps to identify symbols that aren't documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/mediactl/media-header.rst')
-rw-r--r--Documentation/media/uapi/mediactl/media-header.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/media/uapi/mediactl/media-header.rst b/Documentation/media/uapi/mediactl/media-header.rst
new file mode 100644
index 0000000..96f7b01
--- /dev/null
+++ b/Documentation/media/uapi/mediactl/media-header.rst
@@ -0,0 +1,10 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _media_header:
+
+****************************
+Media Controller Header File
+****************************
+
+.. kernel-include:: $BUILDDIR/media.h.rst
+
OpenPOWER on IntegriCloud