[media] docs-rst exceptions: use C domain references for DVB headers

tjh.dev / kernel

fork atom

Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

kernel os linux

fork atom

[media] docs-rst exceptions: use C domain references for DVB headers

Now that we moved away from the :ref: type of references,
we need to update the exceptions lists.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Mauro Carvalho Chehab 9 years ago 836cf1db 59d44bbe

+144 -227

26 changed files

expand all collapse all

Documentation

media

audio.h.rst.exceptions

ca.h.rst.exceptions

dmx.h.rst.exceptions

frontend.h.rst.exceptions

intro.rst

net.h.rst.exceptions

uapi

dvb

audio-bilingual-channel-select.rst

audio-channel-select.rst

audio-select-source.rst

audio-set-attributes.rst

audio-set-karaoke.rst

audio-set-mixer.rst

audio_data_types.rst

dmx_types.rst

fe-bandwidth-t.rst

fe-diseqc-recv-slave-reply.rst

fe-diseqc-send-burst.rst

fe-diseqc-send-master-cmd.rst

fe-get-info.rst

fe-read-status.rst

fe-set-tone.rst

fe-set-voltage.rst

fe-type-t.rst

fe_property_parameters.rst

net-add-if.rst

video.h.rst.exceptions

+3 -3

Documentation/media/audio.h.rst.exceptions

reviewed

··· 2 2 ignore define _DVBAUDIO_H_ 3 3 4 4 # Typedef pointing to structs 5 5 - replace typedef audio_karaoke_t audio-karaoke 5 5 + replace typedef audio_karaoke_t :c:type:`audio_karaoke` 6 6 7 7 # Undocumented audio caps, as this is a deprecated API anyway 8 8 ignore define AUDIO_CAP_DTS ··· 16 16 ignore define AUDIO_CAP_AC3 17 17 18 18 # some typedefs should point to struct/enums 19 19 - replace typedef audio_mixer_t audio-mixer 20 20 - replace typedef audio_status_t audio-status 19 19 + replace typedef audio_mixer_t :c:type:`audio_mixer` 20 20 + replace typedef audio_status_t :c:type:`audio_status`

+16 -16

Documentation/media/ca.h.rst.exceptions

reviewed

··· 2 2 ignore define _DVBCA_H_ 3 3 4 4 # struct ca_slot_info defines 5 5 - replace define CA_CI ca-slot-info 6 6 - replace define CA_CI_LINK ca-slot-info 7 7 - replace define CA_CI_PHYS ca-slot-info 8 8 - replace define CA_DESCR ca-slot-info 9 9 - replace define CA_SC ca-slot-info 10 10 - replace define CA_CI_MODULE_PRESENT ca-slot-info 11 11 - replace define CA_CI_MODULE_READY ca-slot-info 5 5 + replace define CA_CI :c:type:`ca_slot_info` 6 6 + replace define CA_CI_LINK :c:type:`ca_slot_info` 7 7 + replace define CA_CI_PHYS :c:type:`ca_slot_info` 8 8 + replace define CA_DESCR :c:type:`ca_slot_info` 9 9 + replace define CA_SC :c:type:`ca_slot_info` 10 10 + replace define CA_CI_MODULE_PRESENT :c:type:`ca_slot_info` 11 11 + replace define CA_CI_MODULE_READY :c:type:`ca_slot_info` 12 12 13 13 # struct ca_descr_info defines 14 14 - replace define CA_ECD ca-descr-info 15 15 - replace define CA_NDS ca-descr-info 16 16 - replace define CA_DSS ca-descr-info 14 14 + replace define CA_ECD :c:type:`ca_descr_info` 15 15 + replace define CA_NDS :c:type:`ca_descr_info` 16 16 + replace define CA_DSS :c:type:`ca_descr_info` 17 17 18 18 # some typedefs should point to struct/enums 19 19 - replace typedef ca_pid_t ca-pid 20 20 - replace typedef ca_slot_info_t ca-slot-info 21 21 - replace typedef ca_descr_info_t ca-descr-info 22 22 - replace typedef ca_caps_t ca-caps 23 23 - replace typedef ca_msg_t ca-msg 24 24 - replace typedef ca_descr_t ca-descr 19 19 + replace typedef ca_pid_t :c:type:`ca_pid` 20 20 + replace typedef ca_slot_info_t :c:type:`ca_slot_info` 21 21 + replace typedef ca_descr_info_t :c:type:`ca_descr_info` 22 22 + replace typedef ca_caps_t :c:type:`ca_caps` 23 23 + replace typedef ca_msg_t :c:type:`ca_msg` 24 24 + replace typedef ca_descr_t :c:type:`ca_descr`

+44 -41

Documentation/media/dmx.h.rst.exceptions

reviewed

··· 4 4 # Ignore limit constants 5 5 ignore define DMX_FILTER_SIZE 6 6 7 7 - # dmx-pes-type-t enum symbols 8 8 - replace enum dmx_ts_pes dmx-pes-type-t 9 9 - replace symbol DMX_PES_AUDIO0 dmx-pes-type-t 10 10 - replace symbol DMX_PES_VIDEO0 dmx-pes-type-t 11 11 - replace symbol DMX_PES_TELETEXT0 dmx-pes-type-t 12 12 - replace symbol DMX_PES_SUBTITLE0 dmx-pes-type-t 13 13 - replace symbol DMX_PES_PCR0 dmx-pes-type-t 14 14 - replace symbol DMX_PES_AUDIO1 dmx-pes-type-t 15 15 - replace symbol DMX_PES_VIDEO1 dmx-pes-type-t 16 16 - replace symbol DMX_PES_TELETEXT1 dmx-pes-type-t 17 17 - replace symbol DMX_PES_SUBTITLE1 dmx-pes-type-t 18 18 - replace symbol DMX_PES_PCR1 dmx-pes-type-t 19 19 - replace symbol DMX_PES_AUDIO2 dmx-pes-type-t 20 20 - replace symbol DMX_PES_VIDEO2 dmx-pes-type-t 21 21 - replace symbol DMX_PES_TELETEXT2 dmx-pes-type-t 22 22 - replace symbol DMX_PES_SUBTITLE2 dmx-pes-type-t 23 23 - replace symbol DMX_PES_PCR2 dmx-pes-type-t 24 24 - replace symbol DMX_PES_AUDIO3 dmx-pes-type-t 25 25 - replace symbol DMX_PES_VIDEO3 dmx-pes-type-t 26 26 - replace symbol DMX_PES_TELETEXT3 dmx-pes-type-t 27 27 - replace symbol DMX_PES_SUBTITLE3 dmx-pes-type-t 28 28 - replace symbol DMX_PES_PCR3 dmx-pes-type-t 29 29 - replace symbol DMX_PES_OTHER dmx-pes-type-t 7 7 + # dmx_pes_type_t enum symbols 8 8 + replace enum dmx_ts_pes :c:type:`dmx_pes_type` 9 9 + replace symbol DMX_PES_AUDIO0 :c:type:`dmx_pes_type` 10 10 + replace symbol DMX_PES_VIDEO0 :c:type:`dmx_pes_type` 11 11 + replace symbol DMX_PES_TELETEXT0 :c:type:`dmx_pes_type` 12 12 + replace symbol DMX_PES_SUBTITLE0 :c:type:`dmx_pes_type` 13 13 + replace symbol DMX_PES_PCR0 :c:type:`dmx_pes_type` 14 14 + replace symbol DMX_PES_AUDIO1 :c:type:`dmx_pes_type` 15 15 + replace symbol DMX_PES_VIDEO1 :c:type:`dmx_pes_type` 16 16 + replace symbol DMX_PES_TELETEXT1 :c:type:`dmx_pes_type` 17 17 + replace symbol DMX_PES_SUBTITLE1 :c:type:`dmx_pes_type` 18 18 + replace symbol DMX_PES_PCR1 :c:type:`dmx_pes_type` 19 19 + replace symbol DMX_PES_AUDIO2 :c:type:`dmx_pes_type` 20 20 + replace symbol DMX_PES_VIDEO2 :c:type:`dmx_pes_type` 21 21 + replace symbol DMX_PES_TELETEXT2 :c:type:`dmx_pes_type` 22 22 + replace symbol DMX_PES_SUBTITLE2 :c:type:`dmx_pes_type` 23 23 + replace symbol DMX_PES_PCR2 :c:type:`dmx_pes_type` 24 24 + replace symbol DMX_PES_AUDIO3 :c:type:`dmx_pes_type` 25 25 + replace symbol DMX_PES_VIDEO3 :c:type:`dmx_pes_type` 26 26 + replace symbol DMX_PES_TELETEXT3 :c:type:`dmx_pes_type` 27 27 + replace symbol DMX_PES_SUBTITLE3 :c:type:`dmx_pes_type` 28 28 + replace symbol DMX_PES_PCR3 :c:type:`dmx_pes_type` 29 29 + replace symbol DMX_PES_OTHER :c:type:`dmx_pes_type` 30 30 31 31 # Ignore obsolete symbols 32 32 ignore define DMX_PES_AUDIO ··· 36 36 ignore define DMX_PES_PCR 37 37 38 38 # dmx_input_t symbols 39 39 - replace enum dmx_input dmx-input-t 40 40 - replace symbol DMX_IN_FRONTEND dmx-input-t 41 41 - replace symbol DMX_IN_DVR dmx-input-t 39 39 + replace enum dmx_input :c:type:`dmx_input` 40 40 + replace symbol DMX_IN_FRONTEND :c:type:`dmx_input` 41 41 + replace symbol DMX_IN_DVR :c:type:`dmx_input` 42 42 43 43 # dmx_source_t symbols 44 44 - replace enum dmx_source dmx-source-t 45 45 - replace symbol DMX_SOURCE_FRONT0 dmx-source-t 46 46 - replace symbol DMX_SOURCE_FRONT1 dmx-source-t 47 47 - replace symbol DMX_SOURCE_FRONT2 dmx-source-t 48 48 - replace symbol DMX_SOURCE_FRONT3 dmx-source-t 49 49 - replace symbol DMX_SOURCE_DVR0 dmx-source-t 50 50 - replace symbol DMX_SOURCE_DVR1 dmx-source-t 51 51 - replace symbol DMX_SOURCE_DVR2 dmx-source-t 52 52 - replace symbol DMX_SOURCE_DVR3 dmx-source-t 44 44 + replace enum dmx_source :c:type:`dmx_source` 45 45 + replace symbol DMX_SOURCE_FRONT0 :c:type:`dmx_source` 46 46 + replace symbol DMX_SOURCE_FRONT1 :c:type:`dmx_source` 47 47 + replace symbol DMX_SOURCE_FRONT2 :c:type:`dmx_source` 48 48 + replace symbol DMX_SOURCE_FRONT3 :c:type:`dmx_source` 49 49 + replace symbol DMX_SOURCE_DVR0 :c:type:`dmx_source` 50 50 + replace symbol DMX_SOURCE_DVR1 :c:type:`dmx_source` 51 51 + replace symbol DMX_SOURCE_DVR2 :c:type:`dmx_source` 52 52 + replace symbol DMX_SOURCE_DVR3 :c:type:`dmx_source` 53 53 54 54 55 55 # Flags for struct dmx_sct_filter_params 56 56 - replace define DMX_CHECK_CRC dmx-sct-filter-params 57 57 - replace define DMX_ONESHOT dmx-sct-filter-params 58 58 - replace define DMX_IMMEDIATE_START dmx-sct-filter-params 59 59 - replace define DMX_KERNEL_CLIENT dmx-sct-filter-params 56 56 + replace define DMX_CHECK_CRC :c:type:`dmx_sct_filter_params` 57 57 + replace define DMX_ONESHOT :c:type:`dmx_sct_filter_params` 58 58 + replace define DMX_IMMEDIATE_START :c:type:`dmx_sct_filter_params` 59 59 + replace define DMX_KERNEL_CLIENT :c:type:`dmx_sct_filter_params` 60 60 61 61 # some typedefs should point to struct/enums 62 62 - replace typedef dmx_caps_t dmx-caps 63 63 - replace typedef dmx_filter_t dmx-filter 62 62 + replace typedef dmx_caps_t :c:type:`dmx_caps` 63 63 + replace typedef dmx_filter_t :c:type:`dmx_filter` 64 64 + replace typedef dmx_pes_type_t :c:type:`dmx_pes_type` 65 65 + replace typedef dmx_input_t :c:type:`dmx_input` 66 66 + replace typedef dmx_source_t :c:type:`dmx_source`

+4 -4

Documentation/media/frontend.h.rst.exceptions

reviewed

··· 26 26 ignore define DTV_IOCTL_MAX_MSGS 27 27 28 28 # Stats enum is documented altogether 29 29 - replace enum fecap_scale_params frontend-stat-properties 29 29 + replace enum fecap_scale_params :ref:`frontend-stat-properties` 30 30 replace symbol FE_SCALE_COUNTER frontend-stat-properties 31 31 replace symbol FE_SCALE_DECIBEL frontend-stat-properties 32 32 replace symbol FE_SCALE_NOT_AVAILABLE frontend-stat-properties 33 33 replace symbol FE_SCALE_RELATIVE frontend-stat-properties 34 34 35 35 # the same reference is used for both get and set ioctls 36 36 - replace ioctl FE_SET_PROPERTY FE_GET_PROPERTY 36 36 + replace ioctl FE_SET_PROPERTY :c:type:`FE_GET_PROPERTY` 37 37 38 38 # Ignore struct used only internally at Kernel 39 39 ignore struct dtv_cmds_h 40 40 41 41 # Typedefs that use the enum reference 42 42 - replace typedef fe_sec_voltage_t fe-sec-voltage 42 42 + replace typedef fe_sec_voltage_t :c:type:`fe_sec_voltage` 43 43 44 44 # Replaces for flag constants 45 45 - replace define FE_TUNE_MODE_ONESHOT fe_set_frontend_tune_mode 45 45 + replace define FE_TUNE_MODE_ONESHOT :c:func:`FE_SET_FRONTEND_TUNE_MODE` 46 46 replace define LNA_AUTO dtv-lna 47 47 replace define NO_STREAM_ID_FILTER dtv-stream-id

+1 -1

Documentation/media/intro.rst

reviewed

··· 30 30 called as DVB API, in fact it covers several different video standards 31 31 including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S, DTMB, etc. The 32 32 complete list of supported standards can be found at 33 33 - :ref:`fe-delivery-system-t`. 33 33 + :c:type:`fe_delivery_system`. 34 34 35 35 3. The :ref:`third part <remote_controllers>` covers the Remote Controller API. 36 36

+2 -2

Documentation/media/net.h.rst.exceptions

reviewed

··· 7 7 ignore struct __dvb_net_if_old 8 8 9 9 # Macros used at struct dvb_net_if 10 10 - replace define DVB_NET_FEEDTYPE_MPE dvb-net-if 11 11 - replace define DVB_NET_FEEDTYPE_ULE dvb-net-if 10 10 + replace define DVB_NET_FEEDTYPE_MPE :c:type:`dvb_net_if` 11 11 + replace define DVB_NET_FEEDTYPE_ULE :c:type:`dvb_net_if`

+1 -1

Documentation/media/uapi/dvb/audio-bilingual-channel-select.rst

reviewed

··· 16 16 Synopsis 17 17 -------- 18 18 19 19 - .. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t) 19 19 + .. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct *audio_channel_select) 20 20 :name: AUDIO_BILINGUAL_CHANNEL_SELECT 21 21 22 22

+1 -1

Documentation/media/uapi/dvb/audio-channel-select.rst

reviewed

··· 16 16 Synopsis 17 17 -------- 18 18 19 19 - .. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, audio_channel_select_t) 19 19 + .. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, struct *audio_channel_select) 20 20 :name: AUDIO_CHANNEL_SELECT 21 21 22 22

+1 -1

Documentation/media/uapi/dvb/audio-select-source.rst

reviewed

··· 16 16 Synopsis 17 17 -------- 18 18 19 19 - .. c:function:: int ioctl(int fd, AUDIO_SELECT_SOURCE, audio_stream_source_t source) 19 19 + .. c:function:: int ioctl(int fd, AUDIO_SELECT_SOURCE, struct audio_stream_source *source) 20 20 :name: AUDIO_SELECT_SOURCE 21 21 22 22

+1 -1

Documentation/media/uapi/dvb/audio-set-attributes.rst

reviewed

··· 17 17 Synopsis 18 18 -------- 19 19 20 20 - .. c:function:: int ioctl(fd, AUDIO_SET_ATTRIBUTES, audio_attributes_t attr ) 20 20 + .. c:function:: int ioctl(fd, AUDIO_SET_ATTRIBUTES, struct audio_attributes *attr ) 21 21 :name: AUDIO_SET_ATTRIBUTES 22 22 23 23 Arguments

+1 -1

Documentation/media/uapi/dvb/audio-set-karaoke.rst

reviewed

··· 16 16 Synopsis 17 17 -------- 18 18 19 19 - .. c:function:: int ioctl(fd, AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke) 19 19 + .. c:function:: int ioctl(fd, AUDIO_SET_KARAOKE, struct audio_karaoke *karaoke) 20 20 :name: AUDIO_SET_KARAOKE 21 21 22 22

+1 -1

Documentation/media/uapi/dvb/audio-set-mixer.rst

reviewed

··· 16 16 Synopsis 17 17 -------- 18 18 19 19 - .. c:function:: int ioctl(int fd, AUDIO_SET_MIXER, audio_mixer_t *mix) 19 19 + .. c:function:: int ioctl(int fd, AUDIO_SET_MIXER, struct audio_mixer *mix) 20 20 :name: AUDIO_SET_MIXER 21 21 22 22 Arguments

+4 -27

Documentation/media/uapi/dvb/audio_data_types.rst

reviewed

··· 9 9 This section describes the structures, data types and defines used when 10 10 talking to the audio device. 11 11 12 12 - 13 13 - .. _audio-stream-source-t: 14 14 - 15 15 - audio_stream_source_t 16 16 - ===================== 12 12 + .. c:type:: audio_stream_source 17 13 18 14 The audio stream source is set through the AUDIO_SELECT_SOURCE call 19 15 and can take the following values, depending on whether we are replaying ··· 29 33 through the ``write()`` system call. 30 34 31 35 32 32 - .. _audio-play-state-t: 33 33 - 34 34 - audio_play_state_t 35 35 - ================== 36 36 + .. c:type:: audio_play_state 36 37 37 38 The following values can be returned by the AUDIO_GET_STATUS call 38 39 representing the state of audio playback. ··· 44 51 } audio_play_state_t; 45 52 46 53 47 47 - .. _audio-channel-select-t: 48 48 - 49 49 - audio_channel_select_t 50 50 - ====================== 54 54 + .. c:type:: audio_channel_select 51 55 52 56 The audio channel selected via AUDIO_CHANNEL_SELECT is determined by 53 57 the following values. ··· 62 72 63 73 64 74 .. c:type:: audio_status 65 65 - 66 66 - struct audio_status 67 67 - =================== 68 75 69 76 The AUDIO_GET_STATUS call returns the following structure informing 70 77 about various states of the playback operation. ··· 81 94 82 95 83 96 .. c:type:: audio_mixer 84 84 - 85 85 - struct audio_mixer 86 86 - ================== 87 97 88 98 The following structure is used by the AUDIO_SET_MIXER call to set the 89 99 audio volume. ··· 115 131 #define AUDIO_CAP_SDDS 128 116 132 #define AUDIO_CAP_AC3 256 117 133 118 118 - 119 134 .. c:type:: audio_karaoke 120 120 - 121 121 - struct audio_karaoke 122 122 - ==================== 123 135 124 136 The ioctl AUDIO_SET_KARAOKE uses the following format: 125 137 ··· 135 155 Melody is non-zero, the melody channel gets mixed into left and right. 136 156 137 157 138 138 - .. _audio-attributes-t: 139 139 - 140 140 - audio attributes 141 141 - ================ 158 158 + .. c:type:: audio_attributes 142 159 143 160 The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES: 144 161

+14 -25

Documentation/media/uapi/dvb/dmx_types.rst

reviewed

··· 6 6 Demux Data Types 7 7 **************** 8 8 9 9 - 10 10 - .. _dmx-output-t: 11 11 - 12 9 Output for the demux 13 10 ==================== 14 11 15 15 - .. tabularcolumns:: |p{5.0cm}|p{12.5cm}| 12 12 + .. c:type:: dmx_output 16 13 17 17 - .. _dmx-output: 14 14 + .. tabularcolumns:: |p{5.0cm}|p{12.5cm}| 18 15 19 16 .. flat-table:: enum dmx_output 20 17 :header-rows: 1 ··· 63 66 from the DMX device. 64 67 65 68 66 66 - 67 67 - .. _dmx-input-t: 68 68 - 69 69 dmx_input_t 70 70 =========== 71 71 72 72 + .. c:type:: dmx_input 72 73 73 74 .. code-block:: c 74 75 ··· 77 82 } dmx_input_t; 78 83 79 84 80 80 - .. _dmx-pes-type-t: 81 81 - 82 85 dmx_pes_type_t 83 86 ============== 87 87 + 88 88 + .. c:type:: dmx_pes_type 84 89 85 90 86 91 .. code-block:: c ··· 115 120 } dmx_pes_type_t; 116 121 117 122 118 118 - .. c:type:: dmx_filter 119 119 - 120 123 struct dmx_filter 121 124 ================= 122 125 126 126 + .. c:type:: dmx_filter 123 127 124 128 .. code-block:: c 125 129 ··· 151 157 }; 152 158 153 159 154 154 - .. c:type:: dmx_pes_filter_params 155 155 - 156 160 struct dmx_pes_filter_params 157 161 ============================ 158 162 163 163 + .. c:type:: dmx_pes_filter_params 159 164 160 165 .. code-block:: c 161 166 ··· 168 175 }; 169 176 170 177 171 171 - .. _dmx-event: 172 172 - 173 178 struct dmx_event 174 179 ================ 175 180 181 181 + .. c:type:: dmx_event 176 182 177 183 .. code-block:: c 178 184 ··· 186 194 }; 187 195 188 196 189 189 - .. c:type:: dmx_stc 190 190 - 191 197 struct dmx_stc 192 198 ============== 193 199 200 200 + .. c:type:: dmx_stc 194 201 195 202 .. code-block:: c 196 203 ··· 200 209 }; 201 210 202 211 203 203 - .. c:type:: dmx_caps 204 204 - 205 212 struct dmx_caps 206 213 =============== 207 214 215 215 + .. c:type:: dmx_caps 208 216 209 217 .. code-block:: c 210 218 ··· 213 223 } dmx_caps_t; 214 224 215 225 216 216 - .. _dmx-source-t: 226 226 + enum dmx_source 227 227 + =============== 217 228 218 218 - enum dmx_source_t 219 219 - ================= 220 220 - 229 229 + .. c:type:: dmx_source 221 230 222 231 .. code-block:: c 223 232 224 224 - typedef enum { 233 233 + typedef enum dmx_source { 225 234 DMX_SOURCE_FRONT0 = 0, 226 235 DMX_SOURCE_FRONT1, 227 236 DMX_SOURCE_FRONT2,

+1 -4

Documentation/media/uapi/dvb/fe-bandwidth-t.rst

reviewed

··· 1 1 .. -*- coding: utf-8; mode: rst -*- 2 2 3 3 - .. _fe-bandwidth-t: 4 4 - 5 3 ****************** 6 4 Frontend bandwidth 7 5 ****************** 8 6 9 9 - 10 10 - .. _fe-bandwidth: 7 7 + .. c:type:: fe_bandwidth 11 8 12 9 .. flat-table:: enum fe_bandwidth 13 10 :header-rows: 1

-3

Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst

reviewed

··· 37 37 38 38 .. c:type:: dvb_diseqc_slave_reply 39 39 40 40 - struct dvb_diseqc_slave_reply 41 41 - ----------------------------- 42 42 - 43 40 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| 44 41 45 42 .. flat-table:: struct dvb_diseqc_slave_reply

+2 -7

Documentation/media/uapi/dvb/fe-diseqc-send-burst.rst

reviewed

··· 26 26 File descriptor returned by :ref:`open() <frontend_f_open>`. 27 27 28 28 ``tone`` 29 29 - pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>` 29 29 + pointer to enum :c:type:`fe_sec_mini_cmd` 30 30 31 31 32 32 Description ··· 39 39 It provides support for what's specified at 40 40 `Digital Satellite Equipment Control (DiSEqC) - Simple "ToneBurst" Detection Circuit specification. <http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf>`__ 41 41 42 42 - .. _fe-sec-mini-cmd-t: 43 43 - 44 44 - enum fe_sec_mini_cmd 45 45 - ==================== 46 46 - 47 47 - .. _fe-sec-mini-cmd: 42 42 + .. c:type:: fe_sec_mini_cmd 48 43 49 44 .. flat-table:: enum fe_sec_mini_cmd 50 45 :header-rows: 1

+1 -3

Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst

reviewed

··· 35 35 36 36 Sends a DiSEqC command to the antenna subsystem. 37 37 38 38 - .. c:type:: dvb_diseqc_master_cmd 39 38 40 40 - struct dvb_diseqc_master_cmd 41 41 - ============================ 39 39 + .. c:type:: dvb_diseqc_master_cmd 42 40 43 41 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| 44 42

+3 -8

Documentation/media/uapi/dvb/fe-get-info.rst

reviewed

··· 42 42 43 43 .. c:type:: dvb_frontend_info 44 44 45 45 - struct dvb_frontend_info 46 46 - ======================== 47 47 - 48 45 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| 49 46 50 47 .. flat-table:: struct dvb_frontend_info ··· 134 137 135 138 - .. row 11 136 139 137 137 - - enum :ref:`fe_caps <fe-caps>` 140 140 + - enum :c:type:`fe_caps` 138 141 139 142 - caps 140 143 ··· 147 150 systems. They're specified in kHz for Satellite systems 148 151 149 152 150 150 - .. _fe-caps-t: 151 151 - 152 153 frontend capabilities 153 154 ===================== 154 155 155 156 Capabilities describe what a frontend can do. Some capabilities are 156 157 supported only on some specific frontend types. 157 158 158 158 - .. tabularcolumns:: |p{6.5cm}|p{11.0cm}| 159 159 + .. c:type:: fe_caps 159 160 160 160 - .. _fe-caps: 161 161 + .. tabularcolumns:: |p{6.5cm}|p{11.0cm}| 161 162 162 163 .. flat-table:: enum fe_caps 163 164 :header-rows: 1

+4 -4

Documentation/media/uapi/dvb/fe-read-status.rst

reviewed

··· 27 27 28 28 ``status`` 29 29 pointer to a bitmask integer filled with the values defined by enum 30 30 - :ref:`fe_status <fe-status>`. 30 30 + :c:type:`fe_status`. 31 31 32 32 33 33 Description ··· 45 45 future. 46 46 47 47 48 48 - .. _fe-status-t: 49 49 - 50 48 int fe_status 51 49 ============= 52 50 53 51 The fe_status parameter is used to indicate the current state and/or 54 52 state changes of the frontend hardware. It is produced using the enum 55 55 - :ref:`fe_status <fe-status>` values on a bitmask 53 53 + :c:type:`fe_status` values on a bitmask 54 54 + 55 55 + .. c:type:: fe_status 56 56 57 57 .. tabularcolumns:: |p{3.5cm}|p{14.0cm}| 58 58

+2 -7

Documentation/media/uapi/dvb/fe-set-tone.rst

reviewed

··· 26 26 File descriptor returned by :ref:`open() <frontend_f_open>`. 27 27 28 28 ``tone`` 29 29 - pointer to enum :ref:`fe_sec_tone_mode <fe-sec-tone-mode>` 29 29 + pointer to enum :c:type:`fe_sec_tone_mode` 30 30 31 31 32 32 Description ··· 45 45 capability of selecting the band. So, it is recommended that applications 46 46 would change to SEC_TONE_OFF when the device is not used. 47 47 48 48 - .. _fe-sec-tone-mode-t: 49 49 - 50 50 - enum fe_sec_tone_mode 51 51 - ===================== 52 52 - 53 53 - .. _fe-sec-tone-mode: 48 48 + .. c:type:: fe_sec_tone_mode 54 49 55 50 .. flat-table:: enum fe_sec_tone_mode 56 51 :header-rows: 1

+2 -2

Documentation/media/uapi/dvb/fe-set-voltage.rst

reviewed

··· 26 26 File descriptor returned by :ref:`open() <frontend_f_open>`. 27 27 28 28 ``voltage`` 29 29 - pointer to enum :ref:`fe_sec_voltage <fe-sec-voltage>` 29 29 + pointer to enum :c:type:`fe_sec_voltage` 30 30 31 31 Valid values are described at enum 32 32 - :ref:`fe_sec_voltage <fe-sec-voltage>`. 32 32 + :c:type:`fe_sec_voltage`. 33 33 34 34 35 35 Description

+1 -3

Documentation/media/uapi/dvb/fe-type-t.rst

reviewed

··· 1 1 .. -*- coding: utf-8; mode: rst -*- 2 2 3 3 - .. _fe-type-t: 4 4 - 5 3 ************* 6 4 Frontend type 7 5 ************* ··· 9 11 fe_type_t type, defined as: 10 12 11 13 12 12 - .. _fe-type: 14 14 + .. c:type:: fe_type 13 15 14 16 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| 15 17

+24 -45

Documentation/media/uapi/dvb/fe_property_parameters.rst

reviewed

··· 68 68 69 69 Specifies the frontend modulation type for delivery systems that 70 70 supports more than one modulation type. The modulation can be one of the 71 71 - types defined by enum :ref:`fe_modulation <fe-modulation>`. 71 71 + types defined by enum :c:type:`fe_modulation`. 72 72 73 73 74 74 - .. _fe-modulation-t: 74 74 + .. c:type:: fe_modulation 75 75 76 76 Modulation property 77 77 ------------------- ··· 81 81 enum contains the values used by the Kernel. Please note that not all 82 82 modulations are supported by a given standard. 83 83 84 84 - 85 85 - .. _fe-modulation: 86 84 87 85 .. flat-table:: enum fe_modulation 88 86 :header-rows: 1 ··· 249 251 250 252 Specifies if the frontend should do spectral inversion or not. 251 253 252 252 - 253 253 - .. _fe-spectral-inversion-t: 254 254 + .. c:type:: fe_spectral_inversion 254 255 255 256 enum fe_modulation: Frontend spectral inversion 256 257 ----------------------------------------------- ··· 260 263 support, the DVB core will try to lock at the carrier first with 261 264 inversion off. If it fails, it will try to enable inversion. 262 265 263 263 - 264 264 - .. _fe-spectral-inversion: 265 266 266 267 .. flat-table:: enum fe_modulation 267 268 :header-rows: 1 ··· 322 327 323 328 Used cable/satellite transmissions. The acceptable values are: 324 329 325 325 - 326 326 - .. _fe-code-rate-t: 330 330 + .. c:type:: fe_code_rate 327 331 328 332 enum fe_code_rate: type of the Forward Error Correction. 329 333 -------------------------------------------------------- 330 330 - 331 331 - 332 332 - .. _fe-code-rate: 333 334 334 335 .. flat-table:: enum fe_code_rate 335 336 :header-rows: 1 ··· 455 464 described in the DiSEqC spec. 456 465 457 466 458 458 - .. _fe-sec-voltage: 467 467 + .. c:type:: fe_sec_voltage 459 468 460 469 .. flat-table:: enum fe_sec_voltage 461 470 :header-rows: 1 ··· 510 519 Sets DVB-S2 pilot 511 520 512 521 513 513 - .. _fe-pilot-t: 522 522 + .. c:type:: fe_pilot 514 523 515 524 fe_pilot type 516 525 ------------- 517 526 518 518 - 519 519 - .. _fe-pilot: 520 527 521 528 .. flat-table:: enum fe_pilot 522 529 :header-rows: 1 ··· 561 572 Sets DVB-S2 rolloff 562 573 563 574 564 564 - .. _fe-rolloff-t: 575 575 + .. c:type:: fe_rolloff 565 576 566 577 fe_rolloff type 567 578 --------------- 568 579 569 569 - 570 570 - .. _fe-rolloff: 571 580 572 581 .. flat-table:: enum fe_rolloff 573 582 :header-rows: 1 ··· 644 657 Specifies the type of Delivery system 645 658 646 659 647 647 - .. _fe-delivery-system-t: 660 660 + .. c:type:: fe_delivery_system 648 661 649 662 fe_delivery_system type 650 663 ----------------------- 651 664 652 665 Possible values: 653 666 654 654 - 655 655 - .. _fe-delivery-system: 656 667 657 668 .. flat-table:: enum fe_delivery_system 658 669 :header-rows: 1 ··· 1083 1098 TMCC-structure, as shown in the table below. 1084 1099 1085 1100 1086 1086 - .. _isdbt-layer-interleaving-table: 1101 1101 + .. c:type:: isdbt_layer_interleaving_table 1087 1102 1088 1103 .. flat-table:: ISDB-T time interleaving modes 1089 1104 :header-rows: 0 ··· 1220 1235 1221 1236 .. tabularcolumns:: |p{5.0cm}|p{12.5cm}| 1222 1237 1223 1223 - .. _atscmh-rs-frame-mode: 1238 1238 + .. c:type:: atscmh_rs_frame_mode 1224 1239 1225 1240 .. flat-table:: enum atscmh_rs_frame_mode 1226 1241 :header-rows: 1 ··· 1264 1279 Possible values are: 1265 1280 1266 1281 1267 1267 - .. _atscmh-rs-frame-ensemble: 1282 1282 + .. c:type:: atscmh_rs_frame_ensemble 1268 1283 1269 1284 .. flat-table:: enum atscmh_rs_frame_ensemble 1270 1285 :header-rows: 1 ··· 1313 1328 Possible values are: 1314 1329 1315 1330 1316 1316 - .. _atscmh-rs-code-mode: 1331 1331 + .. c:type:: atscmh_rs_code_mode 1317 1332 1318 1333 .. flat-table:: enum atscmh_rs_code_mode 1319 1334 :header-rows: 1 ··· 1368 1383 Reed Solomon (RS) code mode (secondary). 1369 1384 1370 1385 Possible values are the same as documented on enum 1371 1371 - :ref:`atscmh_rs_code_mode <atscmh-rs-code-mode>`: 1386 1386 + :c:type:`atscmh_rs_code_mode`: 1372 1387 1373 1388 1374 1389 .. _DTV-ATSCMH-SCCC-BLOCK-MODE: ··· 1382 1397 1383 1398 .. tabularcolumns:: |p{4.5cm}|p{13.0cm}| 1384 1399 1385 1385 - .. _atscmh-sccc-block-mode: 1400 1400 + .. c:type:: atscmh_sccc_block_mode 1386 1401 1387 1402 .. flat-table:: enum atscmh_scc_block_mode 1388 1403 :header-rows: 1 ··· 1433 1448 Possible values are: 1434 1449 1435 1450 1436 1436 - .. _atscmh-sccc-code-mode: 1451 1451 + .. c:type:: atscmh_sccc_code_mode 1437 1452 1438 1453 .. flat-table:: enum atscmh_sccc_code_mode 1439 1454 :header-rows: 1 ··· 1480 1495 Series Concatenated Convolutional Code Rate. 1481 1496 1482 1497 Possible values are the same as documented on enum 1483 1483 - :ref:`atscmh_sccc_code_mode <atscmh-sccc-code-mode>`. 1498 1498 + :c:type:`atscmh_sccc_code_mode`. 1484 1499 1485 1500 1486 1501 .. _DTV-ATSCMH-SCCC-CODE-MODE-C: ··· 1491 1506 Series Concatenated Convolutional Code Rate. 1492 1507 1493 1508 Possible values are the same as documented on enum 1494 1494 - :ref:`atscmh_sccc_code_mode <atscmh-sccc-code-mode>`. 1509 1509 + :c:type:`atscmh_sccc_code_mode`. 1495 1510 1496 1511 1497 1512 .. _DTV-ATSCMH-SCCC-CODE-MODE-D: ··· 1502 1517 Series Concatenated Convolutional Code Rate. 1503 1518 1504 1519 Possible values are the same as documented on enum 1505 1505 - :ref:`atscmh_sccc_code_mode <atscmh-sccc-code-mode>`. 1520 1520 + :c:type:`atscmh_sccc_code_mode`. 1506 1521 1507 1522 1508 1523 .. _DTV-API-VERSION: ··· 1519 1534 ================ 1520 1535 1521 1536 Used on terrestrial transmissions. The acceptable values are the ones 1522 1522 - described at :ref:`fe_transmit_mode_t <fe-transmit-mode-t>`. 1537 1537 + described at :c:type:`fe_transmit_mode`. 1523 1538 1524 1539 1525 1540 .. _DTV-CODE-RATE-LP: ··· 1528 1543 ================ 1529 1544 1530 1545 Used on terrestrial transmissions. The acceptable values are the ones 1531 1531 - described at :ref:`fe_transmit_mode_t <fe-transmit-mode-t>`. 1546 1546 + described at :c:type:`fe_transmit_mode`. 1532 1547 1533 1548 1534 1549 .. _DTV-GUARD-INTERVAL: ··· 1539 1554 Possible values are: 1540 1555 1541 1556 1542 1542 - .. _fe-guard-interval-t: 1557 1557 + .. c:type:: fe_guard_interval 1543 1558 1544 1559 Modulation guard interval 1545 1560 ------------------------- 1546 1561 1547 1547 - 1548 1548 - .. _fe-guard-interval: 1549 1562 1550 1563 .. flat-table:: enum fe_guard_interval 1551 1564 :header-rows: 1 ··· 1666 1683 on OFTM-based standards, e. g. DVB-T/T2, ISDB-T, DTMB 1667 1684 1668 1685 1669 1669 - .. _fe-transmit-mode-t: 1686 1686 + .. c:type:: fe_transmit_mode 1670 1687 1671 1688 enum fe_transmit_mode: Number of carriers per channel 1672 1689 ----------------------------------------------------- 1673 1690 1674 1691 .. tabularcolumns:: |p{5.0cm}|p{12.5cm}| 1675 1675 - 1676 1676 - .. _fe-transmit-mode: 1677 1692 1678 1693 .. flat-table:: enum fe_transmit_mode 1679 1694 :header-rows: 1 ··· 1782 1801 Frontend hierarchy 1783 1802 1784 1803 1785 1785 - .. _fe-hierarchy-t: 1804 1804 + .. c:type:: fe_hierarchy 1786 1805 1787 1806 Frontend hierarchy 1788 1807 ------------------ 1789 1808 1790 1790 - 1791 1791 - .. _fe-hierarchy: 1792 1809 1793 1810 .. flat-table:: enum fe_hierarchy 1794 1811 :header-rows: 1 ··· 1893 1914 Time interleaving to be used. Currently, used only on DTMB. 1894 1915 1895 1916 1896 1896 - .. _fe-interleaving: 1917 1917 + .. c:type:: fe_interleaving 1897 1918 1898 1919 .. flat-table:: enum fe_interleaving 1899 1920 :header-rows: 1

-6

Documentation/media/uapi/dvb/net-add-if.rst

reviewed

··· 41 41 The struct :c:type:`dvb_net_if`::ifnum field will be 42 42 filled with the number of the created interface. 43 43 44 44 - 45 45 - .. _dvb-net-if-t: 46 46 - 47 47 - struct dvb_net_if description 48 48 - ============================= 49 49 - 50 44 .. c:type:: dvb_net_if 51 45 52 46 .. flat-table:: struct dvb_net_if

+10 -10

Documentation/media/video.h.rst.exceptions

reviewed

··· 28 28 ignore define VIDEO_CAP_CSS 29 29 30 30 # some typedefs should point to struct/enums 31 31 - replace typedef video_format_t video-format 32 32 - replace typedef video_system_t video-system 33 33 - replace typedef video_displayformat_t video-displayformat 34 34 - replace typedef video_size_t video-size 35 35 - replace typedef video_stream_source_t video-stream-source 36 36 - replace typedef video_play_state_t video-play-state 37 37 - replace typedef video_highlight_t video-highlight 38 38 - replace typedef video_spu_t video-spu 39 39 - replace typedef video_spu_palette_t video-spu-palette 40 40 - replace typedef video_navi_pack_t video-navi-pack 31 31 + replace typedef video_format_t :c:type:`video_format` 32 32 + replace typedef video_system_t :c:type:`video_system` 33 33 + replace typedef video_displayformat_t :c:type:`video_displayformat` 34 34 + replace typedef video_size_t :c:type:`video_size` 35 35 + replace typedef video_stream_source_t :c:type:`video_stream_source` 36 36 + replace typedef video_play_state_t :c:type:`video_play_state` 37 37 + replace typedef video_highlight_t :c:type:`video_highlight` 38 38 + replace typedef video_spu_t :c:type:`video_spu` 39 39 + replace typedef video_spu_palette_t :c:type:`video_spu_palette` 40 40 + replace typedef video_navi_pack_t :c:type:`video_navi_pack`