]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/commitdiff
[media] DocBook: Update DocBook version and fix a few legacy things
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Fri, 29 May 2015 13:52:09 +0000 (10:52 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Sat, 30 May 2015 14:16:58 +0000 (11:16 -0300)
The DVB part of the media API documentation has several
legacy things on it:
- Examples that don't work;
- APIs unused and deprecated;
- places mentioning the wrong API version.

Fix them and bump the documentation version, in order to
reflect the cleanup efforts to make it more consistent with
the current status of the API.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Documentation/DocBook/media/dvb/dvbapi.xml
Documentation/DocBook/media/dvb/examples.xml
Documentation/DocBook/media/dvb/intro.xml

index 4c15396c67e5911f0121f9ff21629fc24db0ccf3..dc8cb558f9fd429366c58660b880d36b47e2cb11 100644 (file)
        <holder>Convergence GmbH</holder>
 </copyright>
 <copyright>
-       <year>2009-2014</year>
+       <year>2009-2015</year>
        <holder>Mauro Carvalho Chehab</holder>
 </copyright>
 
 <revhistory>
 <!-- Put document revisions here, newest first. -->
+<revision>
+       <revnumber>2.1.0</revnumber>
+       <date>2015-05-29</date>
+       <authorinitials>mcc</authorinitials>
+       <revremark>
+               DocBook improvements and cleanups, in order to document the
+               system calls on a more standard way and provide more description
+               about the current DVB API.
+       </revremark>
+</revision>
 <revision>
        <revnumber>2.0.4</revnumber>
        <date>2011-05-06</date>
@@ -95,18 +105,26 @@ Added ISDB-T test originally written by Patrick Boettcher
   <chapter id="dvb_demux">
     &sub-demux;
   </chapter>
-  <chapter id="dvb_video">
-    &sub-video;
-  </chapter>
-  <chapter id="dvb_audio">
-    &sub-audio;
-  </chapter>
   <chapter id="dvb_ca">
     &sub-ca;
   </chapter>
   <chapter id="dvb_net">
     &sub-net;
   </chapter>
+  <chapter id="legacy_dvb_apis">
+  <title>DVB Deprecated APIs</title>
+  <para>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</para>
+    <section id="dvb_video">
+       &sub-video;
+    </section>
+    <section id="dvb_audio">
+       &sub-audio;
+    </section>
+  </chapter>
   <chapter id="dvb_kdapi">
     &sub-kdapi;
   </chapter>
index f037e568eb6e7d2ef50a30b8b0aa62fc05c86dfd..c9f68c7183cca21ddd4ef7c9a6549fe56cfa953d 100644 (file)
@@ -1,8 +1,10 @@
 <title>Examples</title>
 <para>In this section we would like to present some examples for using the DVB API.
 </para>
-<para>Maintainer note: This section is out of date. Please refer to the sample programs packaged
-with the driver distribution from <ulink url="http://linuxtv.org/hg/dvb-apps" />.
+<para>NOTE: This section is out of date, and the code below won't even
+    compile. Please refer to the
+    <ulink url="http://linuxtv.org/docs/libdvbv5/index.html">libdvbv5</ulink>
+    for updated/recommended examples.
 </para>
 
 <section id="tuning">
index 4a34ef4783a41b68df0f951ea7a39632180a573a..1f7a35a2b3652eb6539e5c69309ddbc4fcab7e84 100644 (file)
@@ -205,7 +205,7 @@ a partial path like:</para>
 additional include file <emphasis
 role="bold">linux/dvb/version.h</emphasis> exists, which defines the
 constant <emphasis role="bold">DVB_API_VERSION</emphasis>. This document
-describes <emphasis role="bold">DVB_API_VERSION 5.8</emphasis>.
+describes <emphasis role="bold">DVB_API_VERSION 5.10</emphasis>.
 </para>
 
 </section>