media: dvb uapi: move frontend legacy API to another part of the book
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 5 Sep 2017 10:47:08 +0000 (06:47 -0400)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 5 Sep 2017 11:09:57 +0000 (07:09 -0400)
There's a chapter for the legacy APIs. Move the frontend DVBv3
API to it, and update the chapter's introduction accordingly.

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

index b9cfcad3982360c9b0513b926774a34869553857..4967c48d46ce3513c29ad0a3c7f7cba778987f20 100644 (file)
@@ -54,4 +54,3 @@ Data types and ioctl definitions can be accessed by including
     dvb-fe-read-status
     dvbproperty
     frontend_fcalls
-    frontend_legacy_dvbv3_api
index 7eb14d6f729f8868518bb4afa57ac63efde2662a..e1b2c9c7b620b3e6d29e663f5e77631c55e48496 100644 (file)
@@ -6,20 +6,27 @@
 Digital TV Deprecated APIs
 ***************************
 
-The APIs described here are kept only for historical reasons. There's
-just one driver for a very legacy hardware that uses this API. No modern
-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
+The APIs described here **should not** be used on new drivers or applications.
 
-.. note::
+The DVBv3 frontend API has issues with new delivery systems, including
+DVB-S2, DVB-T2, ISDB, etc.
+
+There's just one driver for a very legacy hardware using the Digital TV
+audio and video APIs. No modern drivers should use it. Instead, audio and
+video should be using the V4L2 and ALSA APIs, and the pipelines should
+be set via the Media Controller API.
+
+.. attention::
 
    The APIs described here doesn't necessarily reflect the current
-   code implementation.
+   code implementation, as this section of the document was written
+   for DVB version 1, while the code reflects DVB version 3
+   implementation.
 
 
 .. toctree::
     :maxdepth: 1
 
+    frontend_legacy_dvbv3_api
     video
     audio