media: dvb rst: identify the documentation gap at the API
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 1 Sep 2017 12:53:11 +0000 (08:53 -0400)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 5 Sep 2017 10:13:16 +0000 (06:13 -0400)
Now that DVB spec is almost in sync, document what's missing.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/uapi/dvb/ca.rst
Documentation/media/uapi/dvb/legacy_dvb_apis.rst

index 14b14abda1aee663d352fe180ec562d4d8a04320..e3de778a567883f33e82964bc87d5102f0f0fb4a 100644 (file)
@@ -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
index 2957f5a988b03819fa62099fc0b68348022f1ad8..dac349a1bb27628fb04851e07f8d8011eb944c31 100644 (file)
@@ -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