From 4cde378b3b7cfc65000deab14bfc1b314cb4075b Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Wed, 8 Jun 2011 10:42:22 -0300 Subject: [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 --- Documentation/DocBook/media/Makefile | 1 + Documentation/DocBook/media/dvb/audio.xml | 52 +++++++++++++++---------------- 2 files changed, 27 insertions(+), 26 deletions(-) (limited to 'Documentation/DocBook') 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 = \ -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\\2\<\/link\>\3,g" \ -e "s,\(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\\2\<\/link\>\3,g" \ 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. audio device. -
+
audio_stream_source_t 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 @@ -33,7 +33,7 @@ call.
-
+
audio_play_state_t The following values can be returned by the AUDIO_GET_STATUS call representing the state of audio playback. @@ -47,7 +47,7 @@ state of audio playback.
-
+
audio_channel_select_t The audio channel selected via AUDIO_CHANNEL_SELECT is determined by the following values. @@ -61,7 +61,7 @@ following values.
-
+
struct audio_status The AUDIO_GET_STATUS call returns the following structure informing about various states of the playback operation. @@ -78,7 +78,7 @@ states of the playback operation.
-
+
struct audio_mixer The following structure is used by the AUDIO_SET_MIXER call to set the audio volume. @@ -109,7 +109,7 @@ bits set according to the hardwares capabilities.
-
+
struct audio_karaoke The ioctl AUDIO_SET_KARAOKE uses the following format: @@ -128,7 +128,7 @@ and right.
-
+
audio attributes The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES: @@ -358,7 +358,7 @@ and right. -
AUDIO_STOP DESCRIPTION @@ -409,7 +409,7 @@ role="subsection">AUDIO_STOP -
AUDIO_PLAY DESCRIPTION @@ -461,7 +461,7 @@ role="subsection">AUDIO_PLAY -
AUDIO_PAUSE DESCRIPTION @@ -521,7 +521,7 @@ role="subsection">AUDIO_PAUSE -
AUDIO_SELECT_SOURCE DESCRIPTION @@ -592,7 +592,7 @@ role="subsection">AUDIO_SELECT_SOURCE -
AUDIO_SET_MUTE DESCRIPTION @@ -671,7 +671,7 @@ role="subsection">AUDIO_SET_MUTE -
AUDIO_SET_AV_SYNC DESCRIPTION @@ -750,7 +750,7 @@ role="subsection">AUDIO_SET_AV_SYNC -
AUDIO_SET_BYPASS_MODE DESCRIPTION @@ -833,7 +833,7 @@ role="subsection">AUDIO_SET_BYPASS_MODE -
AUDIO_CHANNEL_SELECT DESCRIPTION @@ -902,7 +902,7 @@ role="subsection">AUDIO_CHANNEL_SELECT -
AUDIO_GET_STATUS DESCRIPTION @@ -970,7 +970,7 @@ role="subsection">AUDIO_GET_STATUS -
AUDIO_GET_CAPABILITIES DESCRIPTION @@ -1038,7 +1038,7 @@ role="subsection">AUDIO_GET_CAPABILITIES -
AUDIO_CLEAR_BUFFER DESCRIPTION @@ -1090,7 +1090,7 @@ role="subsection">AUDIO_CLEAR_BUFFER -
AUDIO_SET_ID DESCRIPTION @@ -1161,7 +1161,7 @@ role="subsection">AUDIO_SET_ID -
AUDIO_SET_MIXER DESCRIPTION @@ -1227,7 +1227,7 @@ role="subsection">AUDIO_SET_MIXER -
AUDIO_SET_STREAMTYPE DESCRIPTION @@ -1288,7 +1288,7 @@ role="subsection">AUDIO_SET_STREAMTYPE -
AUDIO_SET_EXT_ID DESCRIPTION @@ -1348,7 +1348,7 @@ role="subsection">AUDIO_SET_EXT_ID -
AUDIO_SET_ATTRIBUTES DESCRIPTION @@ -1409,7 +1409,7 @@ role="subsection">AUDIO_SET_ATTRIBUTES -
AUDIO_SET_KARAOKE DESCRIPTION @@ -1422,7 +1422,7 @@ role="subsection">AUDIO_SET_KARAOKE -int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, +int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t ⋆karaoke); @@ -1440,7 +1440,7 @@ role="subsection">AUDIO_SET_KARAOKE int request -Equals AUDIO_SET_STREAMTYPE for this +Equals AUDIO_SET_KARAOKE for this command.