Skip to content

L
linux
Commit 4cde378b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files
Options

[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: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent d9d73416
Hide whitespace changes
Inline Side-by-side
Showing with 27 additions and 26 deletions
Documentation/DocBook/media/Makefile
View file @ 4cde378b
...@@ -150,6 +150,7 @@ DVB_DOCUMENTED = \ ...@@ -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,\(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 "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \
-e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \ -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,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" \ -e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
......
Documentation/DocBook/media/dvb/audio.xml
View file @ 4cde378b
...@@ -14,7 +14,7 @@ the omission of the audio and video device. ...@@ -14,7 +14,7 @@ the omission of the audio and video device.
audio device. audio device.
</para> </para>
<section id="audio_stream_source_t"> <section id="audio-stream-source-t">
<title>audio_stream_source_t</title> <title>audio_stream_source_t</title>
<para>The audio stream source is set through the AUDIO_SELECT_SOURCE call and can take <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 the following values, depending on whether we are replaying from an internal (demux) or
...@@ -33,7 +33,7 @@ call. ...@@ -33,7 +33,7 @@ call.
</para> </para>
</section> </section>
<section id="audio_play_state_t"> <section id="audio-play-state-t">
<title>audio_play_state_t</title> <title>audio_play_state_t</title>
<para>The following values can be returned by the AUDIO_GET_STATUS call representing the <para>The following values can be returned by the AUDIO_GET_STATUS call representing the
state of audio playback. state of audio playback.
...@@ -47,7 +47,7 @@ state of audio playback. ...@@ -47,7 +47,7 @@ state of audio playback.
</programlisting> </programlisting>
</section> </section>
<section id="audio_channel_select_t"> <section id="audio-channel-select-t">
<title>audio_channel_select_t</title> <title>audio_channel_select_t</title>
<para>The audio channel selected via AUDIO_CHANNEL_SELECT is determined by the <para>The audio channel selected via AUDIO_CHANNEL_SELECT is determined by the
following values. following values.
...@@ -61,7 +61,7 @@ following values. ...@@ -61,7 +61,7 @@ following values.
</programlisting> </programlisting>
</section> </section>
<section id="struct_audio_status"> <section id="audio-status">
<title>struct audio_status</title> <title>struct audio_status</title>
<para>The AUDIO_GET_STATUS call returns the following structure informing about various <para>The AUDIO_GET_STATUS call returns the following structure informing about various
states of the playback operation. states of the playback operation.
...@@ -78,7 +78,7 @@ states of the playback operation. ...@@ -78,7 +78,7 @@ states of the playback operation.
</programlisting> </programlisting>
</section> </section>
<section id="struct_audio_mixer"> <section id="audio-mixer">
<title>struct audio_mixer</title> <title>struct audio_mixer</title>
<para>The following structure is used by the AUDIO_SET_MIXER call to set the audio <para>The following structure is used by the AUDIO_SET_MIXER call to set the audio
volume. volume.
...@@ -109,7 +109,7 @@ bits set according to the hardwares capabilities. ...@@ -109,7 +109,7 @@ bits set according to the hardwares capabilities.
</programlisting> </programlisting>
</section> </section>
<section id="struct_audio_karaoke"> <section id="audio-karaoke">
<title>struct audio_karaoke</title> <title>struct audio_karaoke</title>
<para>The ioctl AUDIO_SET_KARAOKE uses the following format: <para>The ioctl AUDIO_SET_KARAOKE uses the following format:
</para> </para>
...@@ -128,7 +128,7 @@ and right. ...@@ -128,7 +128,7 @@ and right.
</para> </para>
</section> </section>
<section id="audio_attributes"> <section id="audio-attributes-t">
<title>audio attributes</title> <title>audio attributes</title>
<para>The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES: <para>The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES:
</para> </para>
...@@ -358,7 +358,7 @@ and right. ...@@ -358,7 +358,7 @@ and right.
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_STOP"
role="subsection"><title>AUDIO_STOP</title> role="subsection"><title>AUDIO_STOP</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -409,7 +409,7 @@ role="subsection"><title>AUDIO_STOP</title> ...@@ -409,7 +409,7 @@ role="subsection"><title>AUDIO_STOP</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_PLAY"
role="subsection"><title>AUDIO_PLAY</title> role="subsection"><title>AUDIO_PLAY</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -461,7 +461,7 @@ role="subsection"><title>AUDIO_PLAY</title> ...@@ -461,7 +461,7 @@ role="subsection"><title>AUDIO_PLAY</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_PAUSE"
role="subsection"><title>AUDIO_PAUSE</title> role="subsection"><title>AUDIO_PAUSE</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -521,7 +521,7 @@ role="subsection"><title>AUDIO_PAUSE</title> ...@@ -521,7 +521,7 @@ role="subsection"><title>AUDIO_PAUSE</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SELECT_SOURCE"
role="subsection"><title>AUDIO_SELECT_SOURCE</title> role="subsection"><title>AUDIO_SELECT_SOURCE</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -592,7 +592,7 @@ role="subsection"><title>AUDIO_SELECT_SOURCE</title> ...@@ -592,7 +592,7 @@ role="subsection"><title>AUDIO_SELECT_SOURCE</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SET_MUTE"
role="subsection"><title>AUDIO_SET_MUTE</title> role="subsection"><title>AUDIO_SET_MUTE</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -671,7 +671,7 @@ role="subsection"><title>AUDIO_SET_MUTE</title> ...@@ -671,7 +671,7 @@ role="subsection"><title>AUDIO_SET_MUTE</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SET_AV_SYNC"
role="subsection"><title>AUDIO_SET_AV_SYNC</title> role="subsection"><title>AUDIO_SET_AV_SYNC</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -750,7 +750,7 @@ role="subsection"><title>AUDIO_SET_AV_SYNC</title> ...@@ -750,7 +750,7 @@ role="subsection"><title>AUDIO_SET_AV_SYNC</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SET_BYPASS_MODE"
role="subsection"><title>AUDIO_SET_BYPASS_MODE</title> role="subsection"><title>AUDIO_SET_BYPASS_MODE</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -833,7 +833,7 @@ role="subsection"><title>AUDIO_SET_BYPASS_MODE</title> ...@@ -833,7 +833,7 @@ role="subsection"><title>AUDIO_SET_BYPASS_MODE</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_CHANNEL_SELECT"
role="subsection"><title>AUDIO_CHANNEL_SELECT</title> role="subsection"><title>AUDIO_CHANNEL_SELECT</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -902,7 +902,7 @@ role="subsection"><title>AUDIO_CHANNEL_SELECT</title> ...@@ -902,7 +902,7 @@ role="subsection"><title>AUDIO_CHANNEL_SELECT</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_GET_STATUS"
role="subsection"><title>AUDIO_GET_STATUS</title> role="subsection"><title>AUDIO_GET_STATUS</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -970,7 +970,7 @@ role="subsection"><title>AUDIO_GET_STATUS</title> ...@@ -970,7 +970,7 @@ role="subsection"><title>AUDIO_GET_STATUS</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_GET_CAPABILITIES"
role="subsection"><title>AUDIO_GET_CAPABILITIES</title> role="subsection"><title>AUDIO_GET_CAPABILITIES</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -1038,7 +1038,7 @@ role="subsection"><title>AUDIO_GET_CAPABILITIES</title> ...@@ -1038,7 +1038,7 @@ role="subsection"><title>AUDIO_GET_CAPABILITIES</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_CLEAR_BUFFER"
role="subsection"><title>AUDIO_CLEAR_BUFFER</title> role="subsection"><title>AUDIO_CLEAR_BUFFER</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -1090,7 +1090,7 @@ role="subsection"><title>AUDIO_CLEAR_BUFFER</title> ...@@ -1090,7 +1090,7 @@ role="subsection"><title>AUDIO_CLEAR_BUFFER</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SET_ID"
role="subsection"><title>AUDIO_SET_ID</title> role="subsection"><title>AUDIO_SET_ID</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -1161,7 +1161,7 @@ role="subsection"><title>AUDIO_SET_ID</title> ...@@ -1161,7 +1161,7 @@ role="subsection"><title>AUDIO_SET_ID</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SET_MIXER"
role="subsection"><title>AUDIO_SET_MIXER</title> role="subsection"><title>AUDIO_SET_MIXER</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -1227,7 +1227,7 @@ role="subsection"><title>AUDIO_SET_MIXER</title> ...@@ -1227,7 +1227,7 @@ role="subsection"><title>AUDIO_SET_MIXER</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SET_STREAMTYPE"
role="subsection"><title>AUDIO_SET_STREAMTYPE</title> role="subsection"><title>AUDIO_SET_STREAMTYPE</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -1288,7 +1288,7 @@ role="subsection"><title>AUDIO_SET_STREAMTYPE</title> ...@@ -1288,7 +1288,7 @@ role="subsection"><title>AUDIO_SET_STREAMTYPE</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SET_EXT_ID"
role="subsection"><title>AUDIO_SET_EXT_ID</title> role="subsection"><title>AUDIO_SET_EXT_ID</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -1348,7 +1348,7 @@ role="subsection"><title>AUDIO_SET_EXT_ID</title> ...@@ -1348,7 +1348,7 @@ role="subsection"><title>AUDIO_SET_EXT_ID</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SET_ATTRIBUTES"
role="subsection"><title>AUDIO_SET_ATTRIBUTES</title> role="subsection"><title>AUDIO_SET_ATTRIBUTES</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -1409,7 +1409,7 @@ role="subsection"><title>AUDIO_SET_ATTRIBUTES</title> ...@@ -1409,7 +1409,7 @@ role="subsection"><title>AUDIO_SET_ATTRIBUTES</title>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
</section><section </section><section id="AUDIO_SET_KARAOKE"
role="subsection"><title>AUDIO_SET_KARAOKE</title> role="subsection"><title>AUDIO_SET_KARAOKE</title>
<para>DESCRIPTION <para>DESCRIPTION
</para> </para>
...@@ -1422,7 +1422,7 @@ role="subsection"><title>AUDIO_SET_KARAOKE</title> ...@@ -1422,7 +1422,7 @@ role="subsection"><title>AUDIO_SET_KARAOKE</title>
</para> </para>
<informaltable><tgroup cols="1"><tbody><row><entry <informaltable><tgroup cols="1"><tbody><row><entry
align="char"> 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> audio_karaoke_t &#x22C6;karaoke);</para>
</entry> </entry>
</row></tbody></tgroup></informaltable> </row></tbody></tgroup></informaltable>
...@@ -1440,7 +1440,7 @@ role="subsection"><title>AUDIO_SET_KARAOKE</title> ...@@ -1440,7 +1440,7 @@ role="subsection"><title>AUDIO_SET_KARAOKE</title>
<para>int request</para> <para>int request</para>
</entry><entry </entry><entry
align="char"> align="char">
<para>Equals AUDIO_SET_STREAMTYPE for this <para>Equals AUDIO_SET_KARAOKE for this
command.</para> command.</para>
</entry> </entry>
</row><row><entry </row><row><entry
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7