aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2011-06-08 09:42:22 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-07-27 16:52:55 -0400
commit4cde378b3b7cfc65000deab14bfc1b314cb4075b (patch)
treeeb95ebd32810b7f560eb85112a4c3438c1a2b339 /Documentation/DocBook
parentd9d73416edfad05aa5c34255948a12c3860291f3 (diff)
[media] DocBook/audio.xml: match section ID's with the reference links
Make sure that both audio.h.xml and audio.xml will match the same names. This way, it is now possible to identify API spec gaps: Error: no ID for constraint linkend: AUDIO_CONTINUE. Error: no ID for constraint linkend: AUDIO_GET_PTS. Error: no ID for constraint linkend: AUDIO_BILINGUAL_CHANNEL_SELECT. While here, fix the cut-and-paste description error on AUDIO_SET_KARAOKE. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/Makefile1
-rw-r--r--Documentation/DocBook/media/dvb/audio.xml52
2 files changed, 27 insertions, 26 deletions
diff --git a/Documentation/DocBook/media/Makefile b/Documentation/DocBook/media/Makefile
index a747f2a6c2c1..18604dde1b87 100644
--- a/Documentation/DocBook/media/Makefile
+++ b/Documentation/DocBook/media/Makefile
@@ -150,6 +150,7 @@ DVB_DOCUMENTED = \
150 -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ 150 -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
151 -e "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \ 151 -e "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \
152 -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \ 152 -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
153 -e "s,\(audio-mixer\|audio-karaoke\|audio-status\)-t,\1,g" \
153 -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \ 154 -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \
154 -e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ 155 -e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
155 156
diff --git a/Documentation/DocBook/media/dvb/audio.xml b/Documentation/DocBook/media/dvb/audio.xml
index eeb96b8a0864..60abf9a55d5c 100644
--- a/Documentation/DocBook/media/dvb/audio.xml
+++ b/Documentation/DocBook/media/dvb/audio.xml
@@ -14,7 +14,7 @@ the omission of the audio and video device.
14audio device. 14audio device.
15</para> 15</para>
16 16
17<section id="audio_stream_source_t"> 17<section id="audio-stream-source-t">
18<title>audio_stream_source_t</title> 18<title>audio_stream_source_t</title>
19<para>The audio stream source is set through the AUDIO_SELECT_SOURCE call and can take 19<para>The audio stream source is set through the AUDIO_SELECT_SOURCE call and can take
20the following values, depending on whether we are replaying from an internal (demux) or 20the following values, depending on whether we are replaying from an internal (demux) or
@@ -33,7 +33,7 @@ call.
33</para> 33</para>
34 34
35</section> 35</section>
36<section id="audio_play_state_t"> 36<section id="audio-play-state-t">
37<title>audio_play_state_t</title> 37<title>audio_play_state_t</title>
38<para>The following values can be returned by the AUDIO_GET_STATUS call representing the 38<para>The following values can be returned by the AUDIO_GET_STATUS call representing the
39state of audio playback. 39state of audio playback.
@@ -47,7 +47,7 @@ state of audio playback.
47</programlisting> 47</programlisting>
48 48
49</section> 49</section>
50<section id="audio_channel_select_t"> 50<section id="audio-channel-select-t">
51<title>audio_channel_select_t</title> 51<title>audio_channel_select_t</title>
52<para>The audio channel selected via AUDIO_CHANNEL_SELECT is determined by the 52<para>The audio channel selected via AUDIO_CHANNEL_SELECT is determined by the
53following values. 53following values.
@@ -61,7 +61,7 @@ following values.
61</programlisting> 61</programlisting>
62 62
63</section> 63</section>
64<section id="struct_audio_status"> 64<section id="audio-status">
65<title>struct audio_status</title> 65<title>struct audio_status</title>
66<para>The AUDIO_GET_STATUS call returns the following structure informing about various 66<para>The AUDIO_GET_STATUS call returns the following structure informing about various
67states of the playback operation. 67states of the playback operation.
@@ -78,7 +78,7 @@ states of the playback operation.
78</programlisting> 78</programlisting>
79 79
80</section> 80</section>
81<section id="struct_audio_mixer"> 81<section id="audio-mixer">
82<title>struct audio_mixer</title> 82<title>struct audio_mixer</title>
83<para>The following structure is used by the AUDIO_SET_MIXER call to set the audio 83<para>The following structure is used by the AUDIO_SET_MIXER call to set the audio
84volume. 84volume.
@@ -109,7 +109,7 @@ bits set according to the hardwares capabilities.
109</programlisting> 109</programlisting>
110 110
111</section> 111</section>
112<section id="struct_audio_karaoke"> 112<section id="audio-karaoke">
113<title>struct audio_karaoke</title> 113<title>struct audio_karaoke</title>
114<para>The ioctl AUDIO_SET_KARAOKE uses the following format: 114<para>The ioctl AUDIO_SET_KARAOKE uses the following format:
115</para> 115</para>
@@ -128,7 +128,7 @@ and right.
128</para> 128</para>
129 129
130</section> 130</section>
131<section id="audio_attributes"> 131<section id="audio-attributes-t">
132<title>audio attributes</title> 132<title>audio attributes</title>
133<para>The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES: 133<para>The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES:
134</para> 134</para>
@@ -358,7 +358,7 @@ and right.
358</entry> 358</entry>
359 </row></tbody></tgroup></informaltable> 359 </row></tbody></tgroup></informaltable>
360 360
361</section><section 361</section><section id="AUDIO_STOP"
362role="subsection"><title>AUDIO_STOP</title> 362role="subsection"><title>AUDIO_STOP</title>
363<para>DESCRIPTION 363<para>DESCRIPTION
364</para> 364</para>
@@ -409,7 +409,7 @@ role="subsection"><title>AUDIO_STOP</title>
409</entry> 409</entry>
410 </row></tbody></tgroup></informaltable> 410 </row></tbody></tgroup></informaltable>
411 411
412</section><section 412</section><section id="AUDIO_PLAY"
413role="subsection"><title>AUDIO_PLAY</title> 413role="subsection"><title>AUDIO_PLAY</title>
414<para>DESCRIPTION 414<para>DESCRIPTION
415</para> 415</para>
@@ -461,7 +461,7 @@ role="subsection"><title>AUDIO_PLAY</title>
461</entry> 461</entry>
462 </row></tbody></tgroup></informaltable> 462 </row></tbody></tgroup></informaltable>
463 463
464</section><section 464</section><section id="AUDIO_PAUSE"
465role="subsection"><title>AUDIO_PAUSE</title> 465role="subsection"><title>AUDIO_PAUSE</title>
466<para>DESCRIPTION 466<para>DESCRIPTION
467</para> 467</para>
@@ -521,7 +521,7 @@ role="subsection"><title>AUDIO_PAUSE</title>
521</entry> 521</entry>
522 </row></tbody></tgroup></informaltable> 522 </row></tbody></tgroup></informaltable>
523 523
524</section><section 524</section><section id="AUDIO_SELECT_SOURCE"
525role="subsection"><title>AUDIO_SELECT_SOURCE</title> 525role="subsection"><title>AUDIO_SELECT_SOURCE</title>
526<para>DESCRIPTION 526<para>DESCRIPTION
527</para> 527</para>
@@ -592,7 +592,7 @@ role="subsection"><title>AUDIO_SELECT_SOURCE</title>
592</entry> 592</entry>
593 </row></tbody></tgroup></informaltable> 593 </row></tbody></tgroup></informaltable>
594 594
595</section><section 595</section><section id="AUDIO_SET_MUTE"
596role="subsection"><title>AUDIO_SET_MUTE</title> 596role="subsection"><title>AUDIO_SET_MUTE</title>
597<para>DESCRIPTION 597<para>DESCRIPTION
598</para> 598</para>
@@ -671,7 +671,7 @@ role="subsection"><title>AUDIO_SET_MUTE</title>
671</entry> 671</entry>
672 </row></tbody></tgroup></informaltable> 672 </row></tbody></tgroup></informaltable>
673 673
674</section><section 674</section><section id="AUDIO_SET_AV_SYNC"
675role="subsection"><title>AUDIO_SET_AV_SYNC</title> 675role="subsection"><title>AUDIO_SET_AV_SYNC</title>
676<para>DESCRIPTION 676<para>DESCRIPTION
677</para> 677</para>
@@ -750,7 +750,7 @@ role="subsection"><title>AUDIO_SET_AV_SYNC</title>
750</entry> 750</entry>
751 </row></tbody></tgroup></informaltable> 751 </row></tbody></tgroup></informaltable>
752 752
753</section><section 753</section><section id="AUDIO_SET_BYPASS_MODE"
754role="subsection"><title>AUDIO_SET_BYPASS_MODE</title> 754role="subsection"><title>AUDIO_SET_BYPASS_MODE</title>
755<para>DESCRIPTION 755<para>DESCRIPTION
756</para> 756</para>
@@ -833,7 +833,7 @@ role="subsection"><title>AUDIO_SET_BYPASS_MODE</title>
833</entry> 833</entry>
834 </row></tbody></tgroup></informaltable> 834 </row></tbody></tgroup></informaltable>
835 835
836</section><section 836</section><section id="AUDIO_CHANNEL_SELECT"
837role="subsection"><title>AUDIO_CHANNEL_SELECT</title> 837role="subsection"><title>AUDIO_CHANNEL_SELECT</title>
838<para>DESCRIPTION 838<para>DESCRIPTION
839</para> 839</para>
@@ -902,7 +902,7 @@ role="subsection"><title>AUDIO_CHANNEL_SELECT</title>
902</entry> 902</entry>
903 </row></tbody></tgroup></informaltable> 903 </row></tbody></tgroup></informaltable>
904 904
905</section><section 905</section><section id="AUDIO_GET_STATUS"
906role="subsection"><title>AUDIO_GET_STATUS</title> 906role="subsection"><title>AUDIO_GET_STATUS</title>
907<para>DESCRIPTION 907<para>DESCRIPTION
908</para> 908</para>
@@ -970,7 +970,7 @@ role="subsection"><title>AUDIO_GET_STATUS</title>
970</entry> 970</entry>
971 </row></tbody></tgroup></informaltable> 971 </row></tbody></tgroup></informaltable>
972 972
973</section><section 973</section><section id="AUDIO_GET_CAPABILITIES"
974role="subsection"><title>AUDIO_GET_CAPABILITIES</title> 974role="subsection"><title>AUDIO_GET_CAPABILITIES</title>
975<para>DESCRIPTION 975<para>DESCRIPTION
976</para> 976</para>
@@ -1038,7 +1038,7 @@ role="subsection"><title>AUDIO_GET_CAPABILITIES</title>
1038</entry> 1038</entry>
1039 </row></tbody></tgroup></informaltable> 1039 </row></tbody></tgroup></informaltable>
1040 1040
1041</section><section 1041</section><section id="AUDIO_CLEAR_BUFFER"
1042role="subsection"><title>AUDIO_CLEAR_BUFFER</title> 1042role="subsection"><title>AUDIO_CLEAR_BUFFER</title>
1043<para>DESCRIPTION 1043<para>DESCRIPTION
1044</para> 1044</para>
@@ -1090,7 +1090,7 @@ role="subsection"><title>AUDIO_CLEAR_BUFFER</title>
1090</entry> 1090</entry>
1091 </row></tbody></tgroup></informaltable> 1091 </row></tbody></tgroup></informaltable>
1092 1092
1093</section><section 1093</section><section id="AUDIO_SET_ID"
1094role="subsection"><title>AUDIO_SET_ID</title> 1094role="subsection"><title>AUDIO_SET_ID</title>
1095<para>DESCRIPTION 1095<para>DESCRIPTION
1096</para> 1096</para>
@@ -1161,7 +1161,7 @@ role="subsection"><title>AUDIO_SET_ID</title>
1161</entry> 1161</entry>
1162 </row></tbody></tgroup></informaltable> 1162 </row></tbody></tgroup></informaltable>
1163 1163
1164</section><section 1164</section><section id="AUDIO_SET_MIXER"
1165role="subsection"><title>AUDIO_SET_MIXER</title> 1165role="subsection"><title>AUDIO_SET_MIXER</title>
1166<para>DESCRIPTION 1166<para>DESCRIPTION
1167</para> 1167</para>
@@ -1227,7 +1227,7 @@ role="subsection"><title>AUDIO_SET_MIXER</title>
1227</entry> 1227</entry>
1228 </row></tbody></tgroup></informaltable> 1228 </row></tbody></tgroup></informaltable>
1229 1229
1230</section><section 1230</section><section id="AUDIO_SET_STREAMTYPE"
1231role="subsection"><title>AUDIO_SET_STREAMTYPE</title> 1231role="subsection"><title>AUDIO_SET_STREAMTYPE</title>
1232<para>DESCRIPTION 1232<para>DESCRIPTION
1233</para> 1233</para>
@@ -1288,7 +1288,7 @@ role="subsection"><title>AUDIO_SET_STREAMTYPE</title>
1288</entry> 1288</entry>
1289 </row></tbody></tgroup></informaltable> 1289 </row></tbody></tgroup></informaltable>
1290 1290
1291</section><section 1291</section><section id="AUDIO_SET_EXT_ID"
1292role="subsection"><title>AUDIO_SET_EXT_ID</title> 1292role="subsection"><title>AUDIO_SET_EXT_ID</title>
1293<para>DESCRIPTION 1293<para>DESCRIPTION
1294</para> 1294</para>
@@ -1348,7 +1348,7 @@ role="subsection"><title>AUDIO_SET_EXT_ID</title>
1348</entry> 1348</entry>
1349 </row></tbody></tgroup></informaltable> 1349 </row></tbody></tgroup></informaltable>
1350 1350
1351</section><section 1351</section><section id="AUDIO_SET_ATTRIBUTES"
1352role="subsection"><title>AUDIO_SET_ATTRIBUTES</title> 1352role="subsection"><title>AUDIO_SET_ATTRIBUTES</title>
1353<para>DESCRIPTION 1353<para>DESCRIPTION
1354</para> 1354</para>
@@ -1409,7 +1409,7 @@ role="subsection"><title>AUDIO_SET_ATTRIBUTES</title>
1409</entry> 1409</entry>
1410 </row></tbody></tgroup></informaltable> 1410 </row></tbody></tgroup></informaltable>
1411 1411
1412</section><section 1412</section><section id="AUDIO_SET_KARAOKE"
1413role="subsection"><title>AUDIO_SET_KARAOKE</title> 1413role="subsection"><title>AUDIO_SET_KARAOKE</title>
1414<para>DESCRIPTION 1414<para>DESCRIPTION
1415</para> 1415</para>
@@ -1422,7 +1422,7 @@ role="subsection"><title>AUDIO_SET_KARAOKE</title>
1422</para> 1422</para>
1423<informaltable><tgroup cols="1"><tbody><row><entry 1423<informaltable><tgroup cols="1"><tbody><row><entry
1424 align="char"> 1424 align="char">
1425<para>int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, 1425<para>int ioctl(fd, int request = AUDIO_SET_KARAOKE,
1426 audio_karaoke_t &#x22C6;karaoke);</para> 1426 audio_karaoke_t &#x22C6;karaoke);</para>
1427</entry> 1427</entry>
1428 </row></tbody></tgroup></informaltable> 1428 </row></tbody></tgroup></informaltable>
@@ -1440,7 +1440,7 @@ role="subsection"><title>AUDIO_SET_KARAOKE</title>
1440<para>int request</para> 1440<para>int request</para>
1441</entry><entry 1441</entry><entry
1442 align="char"> 1442 align="char">
1443<para>Equals AUDIO_SET_STREAMTYPE for this 1443<para>Equals AUDIO_SET_KARAOKE for this
1444 command.</para> 1444 command.</para>
1445</entry> 1445</entry>
1446 </row><row><entry 1446 </row><row><entry
generated by cgit v1.2.2 (git 2.25.0) at 2024-11-19 10:09:27 -0500