tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
[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: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
+30
-10
+25
-7
Documentation/DocBook/media/dvb/dvbapi.xml
+25
-7
Documentation/DocBook/media/dvb/dvbapi.xml
···
28
28
<holder>Convergence GmbH</holder>
29
29
</copyright>
30
30
<copyright>
31
-
<year>2009-2014</year>
31
+
<year>2009-2015</year>
32
32
<holder>Mauro Carvalho Chehab</holder>
33
33
</copyright>
34
34
35
35
<revhistory>
36
36
<!-- Put document revisions here, newest first. -->
37
+
<revision>
38
+
<revnumber>2.1.0</revnumber>
39
+
<date>2015-05-29</date>
40
+
<authorinitials>mcc</authorinitials>
41
+
<revremark>
42
+
DocBook improvements and cleanups, in order to document the
43
+
system calls on a more standard way and provide more description
44
+
about the current DVB API.
45
+
</revremark>
46
+
</revision>
37
47
<revision>
38
48
<revnumber>2.0.4</revnumber>
39
49
<date>2011-05-06</date>
···
105
95
<chapter id="dvb_demux">
106
96
&sub-demux;
107
97
</chapter>
108
-
<chapter id="dvb_video">
109
-
&sub-video;
110
-
</chapter>
111
-
<chapter id="dvb_audio">
112
-
&sub-audio;
113
-
</chapter>
114
98
<chapter id="dvb_ca">
115
99
&sub-ca;
116
100
</chapter>
117
101
<chapter id="dvb_net">
118
102
&sub-net;
103
+
</chapter>
104
+
<chapter id="legacy_dvb_apis">
105
+
<title>DVB Deprecated APIs</title>
106
+
<para>The APIs described here are kept only for historical reasons. There's
107
+
just one driver for a very legacy hardware that uses this API. No
108
+
modern drivers should use it. Instead, audio and video should be using
109
+
the V4L2 and ALSA APIs, and the pipelines should be set using the
110
+
Media Controller API</para>
111
+
<section id="dvb_video">
112
+
&sub-video;
113
+
</section>
114
+
<section id="dvb_audio">
115
+
&sub-audio;
116
+
</section>
119
117
</chapter>
120
118
<chapter id="dvb_kdapi">
121
119
&sub-kdapi;
+4
-2
Documentation/DocBook/media/dvb/examples.xml
+4
-2
Documentation/DocBook/media/dvb/examples.xml
···
1
1
<title>Examples</title>
2
2
<para>In this section we would like to present some examples for using the DVB API.
3
3
</para>
4
-
<para>Maintainer note: This section is out of date. Please refer to the sample programs packaged
5
-
with the driver distribution from <ulink url="http://linuxtv.org/hg/dvb-apps" />.
4
+
<para>NOTE: This section is out of date, and the code below won't even
5
+
compile. Please refer to the
6
+
<ulink url="http://linuxtv.org/docs/libdvbv5/index.html">libdvbv5</ulink>
7
+
for updated/recommended examples.
6
8
</para>
7
9
8
10
<section id="tuning">
+1
-1
Documentation/DocBook/media/dvb/intro.xml
+1
-1
Documentation/DocBook/media/dvb/intro.xml
···
205
205
additional include file <emphasis
206
206
role="bold">linux/dvb/version.h</emphasis> exists, which defines the
207
207
constant <emphasis role="bold">DVB_API_VERSION</emphasis>. This document
208
-
describes <emphasis role="bold">DVB_API_VERSION 5.8</emphasis>.
208
+
describes <emphasis role="bold">DVB_API_VERSION 5.10</emphasis>.
209
209
</para>
210
210
211
211
</section>