From bbed074e8c58d9bf8fd7a57b1d796e1c43b43e75 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 1 Sep 2017 08:53:11 -0400 Subject: [PATCH] media: dvb rst: identify the documentation gap at the API Now that DVB spec is almost in sync, document what's missing. Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/uapi/dvb/ca.rst | 5 +++++ Documentation/media/uapi/dvb/legacy_dvb_apis.rst | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/Documentation/media/uapi/dvb/ca.rst b/Documentation/media/uapi/dvb/ca.rst index 14b14abda1ae..e3de778a5678 100644 --- a/Documentation/media/uapi/dvb/ca.rst +++ b/Documentation/media/uapi/dvb/ca.rst @@ -10,6 +10,11 @@ accessed through ``/dev/dvb/adapter?/ca?``. Data types and and ioctl definitions can be accessed by including ``linux/dvb/ca.h`` in your application. +.. note:: + + There are three ioctls at this API that aren't documented: + :ref:`CA_GET_MSG`, :ref:`CA_SEND_MSG` and :ref:`CA_SET_DESCR`. + Documentation for them are welcome. .. toctree:: :maxdepth: 1 diff --git a/Documentation/media/uapi/dvb/legacy_dvb_apis.rst b/Documentation/media/uapi/dvb/legacy_dvb_apis.rst index 2957f5a988b0..dac349a1bb27 100644 --- a/Documentation/media/uapi/dvb/legacy_dvb_apis.rst +++ b/Documentation/media/uapi/dvb/legacy_dvb_apis.rst @@ -12,6 +12,11 @@ drivers should use it. Instead, audio and video should be using the V4L2 and ALSA APIs, and the pipelines should be set using the Media Controller API +.. note:: + + The APIs described here doesn't necessarily reflect the current + code implementation. + .. toctree:: :maxdepth: 1 -- 2.20.1