Skip to content

Commit

Permalink
[media] DocBook/audio.xml: match section ID's with the reference links
Browse files Browse the repository at this point in the history 
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>
  • Loading branch information
Mauro Carvalho Chehab committed Jul 27, 2011
1 parent d9d7341 commit 4cde378
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 26 deletions.
1 change: 1 addition & 0 deletions Documentation/DocBook/media/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ DVB_DOCUMENTED = \
-e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
-e "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \
-e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
-e "s,\(audio-mixer\|audio-karaoke\|audio-status\)-t,\1,g" \
-e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \
-e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \

Expand Down
52 changes: 26 additions & 26 deletions Documentation/DocBook/media/dvb/audio.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ the omission of the audio and video device.
audio device.
</para>

<section id="audio_stream_source_t">
<section id="audio-stream-source-t">
<title>audio_stream_source_t</title>
<para>The audio stream source is set through the AUDIO_SELECT_SOURCE call and can take
the following values, depending on whether we are replaying from an internal (demux) or
Expand All @@ -33,7 +33,7 @@ call.
</para>

</section>
<section id="audio_play_state_t">
<section id="audio-play-state-t">
<title>audio_play_state_t</title>
<para>The following values can be returned by the AUDIO_GET_STATUS call representing the
state of audio playback.
Expand All @@ -47,7 +47,7 @@ state of audio playback.
</programlisting>

</section>
<section id="audio_channel_select_t">
<section id="audio-channel-select-t">
<title>audio_channel_select_t</title>
<para>The audio channel selected via AUDIO_CHANNEL_SELECT is determined by the
following values.
Expand All @@ -61,7 +61,7 @@ following values.
</programlisting>

</section>
<section id="struct_audio_status">
<section id="audio-status">
<title>struct audio_status</title>
<para>The AUDIO_GET_STATUS call returns the following structure informing about various
states of the playback operation.
Expand All @@ -78,7 +78,7 @@ states of the playback operation.
</programlisting>

</section>
<section id="struct_audio_mixer">
<section id="audio-mixer">
<title>struct audio_mixer</title>
<para>The following structure is used by the AUDIO_SET_MIXER call to set the audio
volume.
Expand Down Expand Up @@ -109,7 +109,7 @@ bits set according to the hardwares capabilities.
</programlisting>

</section>
<section id="struct_audio_karaoke">
<section id="audio-karaoke">
<title>struct audio_karaoke</title>
<para>The ioctl AUDIO_SET_KARAOKE uses the following format:
</para>
Expand All @@ -128,7 +128,7 @@ and right.
</para>

</section>
<section id="audio_attributes">
<section id="audio-attributes-t">
<title>audio attributes</title>
<para>The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES:
</para>
Expand Down Expand Up @@ -358,7 +358,7 @@ and right.
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_STOP"
role="subsection"><title>AUDIO_STOP</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -409,7 +409,7 @@ role="subsection"><title>AUDIO_STOP</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_PLAY"
role="subsection"><title>AUDIO_PLAY</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -461,7 +461,7 @@ role="subsection"><title>AUDIO_PLAY</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_PAUSE"
role="subsection"><title>AUDIO_PAUSE</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -521,7 +521,7 @@ role="subsection"><title>AUDIO_PAUSE</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SELECT_SOURCE"
role="subsection"><title>AUDIO_SELECT_SOURCE</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -592,7 +592,7 @@ role="subsection"><title>AUDIO_SELECT_SOURCE</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SET_MUTE"
role="subsection"><title>AUDIO_SET_MUTE</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -671,7 +671,7 @@ role="subsection"><title>AUDIO_SET_MUTE</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SET_AV_SYNC"
role="subsection"><title>AUDIO_SET_AV_SYNC</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -750,7 +750,7 @@ role="subsection"><title>AUDIO_SET_AV_SYNC</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SET_BYPASS_MODE"
role="subsection"><title>AUDIO_SET_BYPASS_MODE</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -833,7 +833,7 @@ role="subsection"><title>AUDIO_SET_BYPASS_MODE</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_CHANNEL_SELECT"
role="subsection"><title>AUDIO_CHANNEL_SELECT</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -902,7 +902,7 @@ role="subsection"><title>AUDIO_CHANNEL_SELECT</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_GET_STATUS"
role="subsection"><title>AUDIO_GET_STATUS</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -970,7 +970,7 @@ role="subsection"><title>AUDIO_GET_STATUS</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_GET_CAPABILITIES"
role="subsection"><title>AUDIO_GET_CAPABILITIES</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -1038,7 +1038,7 @@ role="subsection"><title>AUDIO_GET_CAPABILITIES</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_CLEAR_BUFFER"
role="subsection"><title>AUDIO_CLEAR_BUFFER</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -1090,7 +1090,7 @@ role="subsection"><title>AUDIO_CLEAR_BUFFER</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SET_ID"
role="subsection"><title>AUDIO_SET_ID</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -1161,7 +1161,7 @@ role="subsection"><title>AUDIO_SET_ID</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SET_MIXER"
role="subsection"><title>AUDIO_SET_MIXER</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -1227,7 +1227,7 @@ role="subsection"><title>AUDIO_SET_MIXER</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SET_STREAMTYPE"
role="subsection"><title>AUDIO_SET_STREAMTYPE</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -1288,7 +1288,7 @@ role="subsection"><title>AUDIO_SET_STREAMTYPE</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SET_EXT_ID"
role="subsection"><title>AUDIO_SET_EXT_ID</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -1348,7 +1348,7 @@ role="subsection"><title>AUDIO_SET_EXT_ID</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SET_ATTRIBUTES"
role="subsection"><title>AUDIO_SET_ATTRIBUTES</title>
<para>DESCRIPTION
</para>
Expand Down Expand Up @@ -1409,7 +1409,7 @@ role="subsection"><title>AUDIO_SET_ATTRIBUTES</title>
</entry>
</row></tbody></tgroup></informaltable>

</section><section
</section><section id="AUDIO_SET_KARAOKE"
role="subsection"><title>AUDIO_SET_KARAOKE</title>
<para>DESCRIPTION
</para>
Expand All @@ -1422,7 +1422,7 @@ role="subsection"><title>AUDIO_SET_KARAOKE</title>
</para>
<informaltable><tgroup cols="1"><tbody><row><entry
align="char">
<para>int ioctl(fd, int request = AUDIO_SET_STREAMTYPE,
<para>int ioctl(fd, int request = AUDIO_SET_KARAOKE,
audio_karaoke_t &#x22C6;karaoke);</para>
</entry>
</row></tbody></tgroup></informaltable>
Expand All @@ -1440,7 +1440,7 @@ role="subsection"><title>AUDIO_SET_KARAOKE</title>
<para>int request</para>
</entry><entry
align="char">
<para>Equals AUDIO_SET_STREAMTYPE for this
<para>Equals AUDIO_SET_KARAOKE for this
command.</para>
</entry>
</row><row><entry
Expand Down

0 comments on commit 4cde378

Please sign in to comment.