summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/mediactl/media-ioc-enum-links.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-ioc-enum-links.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-ioc-enum-links.rst')
-rw-r--r--Documentation/media/uapi/mediactl/media-ioc-enum-links.rst8
1 files changed, 3 insertions, 5 deletions
diff --git a/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst b/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst
index cc3cc3d2..87443b1 100644
--- a/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst
+++ b/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _media-ioc-enum-links:
+.. _media_ioc_enum_links:
**************************
ioctl MEDIA_IOC_ENUM_LINKS
@@ -44,14 +44,12 @@ MEDIA_IOC_ENUM_LINKS ioctl with a pointer to this structure.
If the ``pads`` field is not NULL, the driver fills the ``pads`` array
with information about the entity's pads. The array must have enough
room to store all the entity's pads. The number of pads can be retrieved
-with the :ref:`MEDIA_IOC_ENUM_ENTITIES <media-ioc-enum-entities>`
-ioctl.
+with :ref:`MEDIA_IOC_ENUM_ENTITIES`.
If the ``links`` field is not NULL, the driver fills the ``links`` array
with information about the entity's outbound links. The array must have
enough room to store all the entity's outbound links. The number of
-outbound links can be retrieved with the
-:ref:`MEDIA_IOC_ENUM_ENTITIES <media-ioc-enum-entities>` ioctl.
+outbound links can be retrieved with :ref:`MEDIA_IOC_ENUM_ENTITIES`.
Only forward links that originate at one of the entity's source pads are
returned during the enumeration process.
OpenPOWER on IntegriCloud