Commit d2c68150 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent fb6fc6c9

Documentation/media/Makefile

+4 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ UAPI = $(srctree)/include/uapi/linux 
SRC_DIR=$(srctree)/Documentation/media



FILES = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \

	  videodev2.h.rst

	  videodev2.h.rst media.h.rst



TARGETS := $(addprefix $(BUILDDIR)/, $(FILES))
@@ -46,5 +46,8 @@ $(BUILDDIR)/video.h.rst: ${UAPI}/dvb/video.h ${PARSER} $(SRC_DIR)/video.h.rst.ex 
$(BUILDDIR)/videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2.h.rst.exceptions

	@$($(quiet)gen_rst)



$(BUILDDIR)/media.h.rst: ${UAPI}/media.h ${PARSER} $(SRC_DIR)/media.h.rst.exceptions

	@$($(quiet)gen_rst)



cleandocs:

	-rm ${TARGETS}

Documentation/media/media.h.rst.exceptions

0 → 100644
+30 −0
Original line number Diff line number Diff line 
# Ignore header name

ignore define __LINUX_MEDIA_H



# Ignore macros

ignore define MEDIA_API_VERSION

ignore define MEDIA_ENT_F_BASE

ignore define MEDIA_ENT_F_OLD_BASE

ignore define MEDIA_ENT_F_OLD_SUBDEV_BASE

ignore define MEDIA_INTF_T_DVB_BASE

ignore define MEDIA_INTF_T_V4L_BASE

ignore define MEDIA_INTF_T_ALSA_BASE



#ignore legacy entity type macros

ignore define MEDIA_ENT_TYPE_SHIFT

ignore define MEDIA_ENT_TYPE_MASK

ignore define MEDIA_ENT_SUBTYPE_MASK

ignore define MEDIA_ENT_T_DEVNODE_UNKNOWN

ignore define MEDIA_ENT_T_DEVNODE

ignore define MEDIA_ENT_T_DEVNODE_V4L

ignore define MEDIA_ENT_T_DEVNODE_FB

ignore define MEDIA_ENT_T_DEVNODE_ALSA

ignore define MEDIA_ENT_T_DEVNODE_DVB

ignore define MEDIA_ENT_T_UNKNOWN

ignore define MEDIA_ENT_T_V4L2_VIDEO

ignore define MEDIA_ENT_T_V4L2_SUBDEV

ignore define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR

ignore define MEDIA_ENT_T_V4L2_SUBDEV_FLASH

ignore define MEDIA_ENT_T_V4L2_SUBDEV_LENS

ignore define MEDIA_ENT_T_V4L2_SUBDEV_DECODER

ignore define MEDIA_ENT_T_V4L2_SUBDEV_TUNER

Documentation/media/uapi/mediactl/media-controller.rst

+1 −1
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ Media Controller 
    media-controller-intro

    media-controller-model

    media-types



    media-header



.. _media-user-func:

Documentation/media/uapi/mediactl/media-header.rst

0 → 100644
+10 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _media_header:



****************************

Media Controller Header File

****************************



.. kernel-include:: $BUILDDIR/media.h.rst

Documentation/media/uapi/mediactl/media-ioc-device-info.rst

+1 −1
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _media-ioc-device-info:

.. _media_ioc_device_info:



***************************

ioctl MEDIA_IOC_DEVICE_INFO