Commit 1e35c77d authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] DocBook: Update DocBook version and fix a few legacy things

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: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 87db4553
...@@ -28,12 +28,22 @@ ...@@ -28,12 +28,22 @@
<holder>Convergence GmbH</holder> <holder>Convergence GmbH</holder>
</copyright> </copyright>
<copyright> <copyright>
<year>2009-2014</year> <year>2009-2015</year>
<holder>Mauro Carvalho Chehab</holder> <holder>Mauro Carvalho Chehab</holder>
</copyright> </copyright>
<revhistory> <revhistory>
<!-- Put document revisions here, newest first. --> <!-- 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> <revision>
<revnumber>2.0.4</revnumber> <revnumber>2.0.4</revnumber>
<date>2011-05-06</date> <date>2011-05-06</date>
...@@ -95,18 +105,26 @@ Added ISDB-T test originally written by Patrick Boettcher ...@@ -95,18 +105,26 @@ Added ISDB-T test originally written by Patrick Boettcher
<chapter id="dvb_demux"> <chapter id="dvb_demux">
&sub-demux; &sub-demux;
</chapter> </chapter>
<chapter id="dvb_video">
&sub-video;
</chapter>
<chapter id="dvb_audio">
&sub-audio;
</chapter>
<chapter id="dvb_ca"> <chapter id="dvb_ca">
&sub-ca; &sub-ca;
</chapter> </chapter>
<chapter id="dvb_net"> <chapter id="dvb_net">
&sub-net; &sub-net;
</chapter> </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"> <chapter id="dvb_kdapi">
&sub-kdapi; &sub-kdapi;
</chapter> </chapter>
......
<title>Examples</title> <title>Examples</title>
<para>In this section we would like to present some examples for using the DVB API. <para>In this section we would like to present some examples for using the DVB API.
</para> </para>
<para>Maintainer note: This section is out of date. Please refer to the sample programs packaged <para>NOTE: This section is out of date, and the code below won't even
with the driver distribution from <ulink url="http://linuxtv.org/hg/dvb-apps" />. compile. Please refer to the
<ulink url="http://linuxtv.org/docs/libdvbv5/index.html">libdvbv5</ulink>
for updated/recommended examples.
</para> </para>
<section id="tuning"> <section id="tuning">
......
...@@ -205,7 +205,7 @@ a partial path like:</para> ...@@ -205,7 +205,7 @@ a partial path like:</para>
additional include file <emphasis additional include file <emphasis
role="bold">linux/dvb/version.h</emphasis> exists, which defines the role="bold">linux/dvb/version.h</emphasis> exists, which defines the
constant <emphasis role="bold">DVB_API_VERSION</emphasis>. This document 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> </para>
</section> </section>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment