Commit 836cf1db authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 59d44bbe

Documentation/media/audio.h.rst.exceptions

+3 −3
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
ignore define _DVBAUDIO_H_



# Typedef pointing to structs

replace typedef audio_karaoke_t audio-karaoke

replace typedef audio_karaoke_t :c:type:`audio_karaoke`



# Undocumented audio caps, as this is a deprecated API anyway

ignore define AUDIO_CAP_DTS
@@ -16,5 +16,5 @@ ignore define AUDIO_CAP_SDDS 
ignore define AUDIO_CAP_AC3



# some typedefs should point to struct/enums

replace typedef audio_mixer_t audio-mixer

replace typedef audio_status_t audio-status
 
replace typedef audio_mixer_t :c:type:`audio_mixer`

replace typedef audio_status_t :c:type:`audio_status`

Documentation/media/ca.h.rst.exceptions

+16 −16
Original line number Diff line number Diff line
@@ -2,23 +2,23 @@ 
ignore define _DVBCA_H_



# struct ca_slot_info defines

replace define CA_CI ca-slot-info

replace define CA_CI_LINK ca-slot-info

replace define CA_CI_PHYS ca-slot-info

replace define CA_DESCR ca-slot-info

replace define CA_SC ca-slot-info

replace define CA_CI_MODULE_PRESENT ca-slot-info

replace define CA_CI_MODULE_READY ca-slot-info

replace define CA_CI :c:type:`ca_slot_info`

replace define CA_CI_LINK :c:type:`ca_slot_info`

replace define CA_CI_PHYS :c:type:`ca_slot_info`

replace define CA_DESCR :c:type:`ca_slot_info`

replace define CA_SC :c:type:`ca_slot_info`

replace define CA_CI_MODULE_PRESENT :c:type:`ca_slot_info`

replace define CA_CI_MODULE_READY :c:type:`ca_slot_info`



# struct ca_descr_info defines

replace define CA_ECD ca-descr-info

replace define CA_NDS ca-descr-info

replace define CA_DSS ca-descr-info

replace define CA_ECD :c:type:`ca_descr_info`

replace define CA_NDS :c:type:`ca_descr_info`

replace define CA_DSS :c:type:`ca_descr_info`



# some typedefs should point to struct/enums

replace typedef ca_pid_t ca-pid

replace typedef ca_slot_info_t ca-slot-info

replace typedef ca_descr_info_t ca-descr-info

replace typedef ca_caps_t ca-caps

replace typedef ca_msg_t ca-msg

replace typedef ca_descr_t ca-descr
 
replace typedef ca_pid_t :c:type:`ca_pid`

replace typedef ca_slot_info_t :c:type:`ca_slot_info`

replace typedef ca_descr_info_t :c:type:`ca_descr_info`

replace typedef ca_caps_t :c:type:`ca_caps`

replace typedef ca_msg_t :c:type:`ca_msg`

replace typedef ca_descr_t :c:type:`ca_descr`

Documentation/media/dmx.h.rst.exceptions

+44 −41
Original line number Diff line number Diff line
@@ -4,29 +4,29 @@ ignore define _UAPI_DVBDMX_H_ 
# Ignore limit constants

ignore define DMX_FILTER_SIZE



# dmx-pes-type-t enum symbols

replace enum dmx_ts_pes dmx-pes-type-t

replace symbol DMX_PES_AUDIO0 dmx-pes-type-t

replace symbol DMX_PES_VIDEO0 dmx-pes-type-t

replace symbol DMX_PES_TELETEXT0 dmx-pes-type-t

replace symbol DMX_PES_SUBTITLE0 dmx-pes-type-t

replace symbol DMX_PES_PCR0 dmx-pes-type-t

replace symbol DMX_PES_AUDIO1 dmx-pes-type-t

replace symbol DMX_PES_VIDEO1 dmx-pes-type-t

replace symbol DMX_PES_TELETEXT1 dmx-pes-type-t

replace symbol DMX_PES_SUBTITLE1 dmx-pes-type-t

replace symbol DMX_PES_PCR1 dmx-pes-type-t

replace symbol DMX_PES_AUDIO2 dmx-pes-type-t

replace symbol DMX_PES_VIDEO2 dmx-pes-type-t

replace symbol DMX_PES_TELETEXT2 dmx-pes-type-t

replace symbol DMX_PES_SUBTITLE2 dmx-pes-type-t

replace symbol DMX_PES_PCR2 dmx-pes-type-t

replace symbol DMX_PES_AUDIO3 dmx-pes-type-t

replace symbol DMX_PES_VIDEO3 dmx-pes-type-t

replace symbol DMX_PES_TELETEXT3 dmx-pes-type-t

replace symbol DMX_PES_SUBTITLE3 dmx-pes-type-t

replace symbol DMX_PES_PCR3 dmx-pes-type-t

replace symbol DMX_PES_OTHER dmx-pes-type-t

# dmx_pes_type_t enum symbols

replace enum dmx_ts_pes :c:type:`dmx_pes_type`

replace symbol DMX_PES_AUDIO0 :c:type:`dmx_pes_type`

replace symbol DMX_PES_VIDEO0 :c:type:`dmx_pes_type`

replace symbol DMX_PES_TELETEXT0 :c:type:`dmx_pes_type`

replace symbol DMX_PES_SUBTITLE0 :c:type:`dmx_pes_type`

replace symbol DMX_PES_PCR0 :c:type:`dmx_pes_type`

replace symbol DMX_PES_AUDIO1 :c:type:`dmx_pes_type`

replace symbol DMX_PES_VIDEO1 :c:type:`dmx_pes_type`

replace symbol DMX_PES_TELETEXT1 :c:type:`dmx_pes_type`

replace symbol DMX_PES_SUBTITLE1 :c:type:`dmx_pes_type`

replace symbol DMX_PES_PCR1 :c:type:`dmx_pes_type`

replace symbol DMX_PES_AUDIO2 :c:type:`dmx_pes_type`

replace symbol DMX_PES_VIDEO2 :c:type:`dmx_pes_type`

replace symbol DMX_PES_TELETEXT2 :c:type:`dmx_pes_type`

replace symbol DMX_PES_SUBTITLE2 :c:type:`dmx_pes_type`

replace symbol DMX_PES_PCR2 :c:type:`dmx_pes_type`

replace symbol DMX_PES_AUDIO3 :c:type:`dmx_pes_type`

replace symbol DMX_PES_VIDEO3 :c:type:`dmx_pes_type`

replace symbol DMX_PES_TELETEXT3 :c:type:`dmx_pes_type`

replace symbol DMX_PES_SUBTITLE3 :c:type:`dmx_pes_type`

replace symbol DMX_PES_PCR3 :c:type:`dmx_pes_type`

replace symbol DMX_PES_OTHER :c:type:`dmx_pes_type`



# Ignore obsolete symbols

ignore define DMX_PES_AUDIO
@@ -36,28 +36,31 @@ ignore define DMX_PES_SUBTITLE 
ignore define DMX_PES_PCR



# dmx_input_t symbols

replace enum dmx_input dmx-input-t

replace symbol DMX_IN_FRONTEND dmx-input-t

replace symbol DMX_IN_DVR dmx-input-t

replace enum dmx_input :c:type:`dmx_input`

replace symbol DMX_IN_FRONTEND :c:type:`dmx_input`

replace symbol DMX_IN_DVR :c:type:`dmx_input`



# dmx_source_t symbols

replace enum dmx_source dmx-source-t

replace symbol DMX_SOURCE_FRONT0 dmx-source-t

replace symbol DMX_SOURCE_FRONT1 dmx-source-t

replace symbol DMX_SOURCE_FRONT2 dmx-source-t

replace symbol DMX_SOURCE_FRONT3 dmx-source-t

replace symbol DMX_SOURCE_DVR0 dmx-source-t

replace symbol DMX_SOURCE_DVR1 dmx-source-t

replace symbol DMX_SOURCE_DVR2 dmx-source-t

replace symbol DMX_SOURCE_DVR3 dmx-source-t

replace enum dmx_source :c:type:`dmx_source`

replace symbol DMX_SOURCE_FRONT0 :c:type:`dmx_source`

replace symbol DMX_SOURCE_FRONT1 :c:type:`dmx_source`

replace symbol DMX_SOURCE_FRONT2 :c:type:`dmx_source`

replace symbol DMX_SOURCE_FRONT3 :c:type:`dmx_source`

replace symbol DMX_SOURCE_DVR0 :c:type:`dmx_source`

replace symbol DMX_SOURCE_DVR1 :c:type:`dmx_source`

replace symbol DMX_SOURCE_DVR2 :c:type:`dmx_source`

replace symbol DMX_SOURCE_DVR3 :c:type:`dmx_source`





# Flags for struct dmx_sct_filter_params

replace define DMX_CHECK_CRC dmx-sct-filter-params

replace define DMX_ONESHOT dmx-sct-filter-params

replace define DMX_IMMEDIATE_START dmx-sct-filter-params

replace define DMX_KERNEL_CLIENT dmx-sct-filter-params

replace define DMX_CHECK_CRC :c:type:`dmx_sct_filter_params`

replace define DMX_ONESHOT :c:type:`dmx_sct_filter_params`

replace define DMX_IMMEDIATE_START :c:type:`dmx_sct_filter_params`

replace define DMX_KERNEL_CLIENT :c:type:`dmx_sct_filter_params`



# some typedefs should point to struct/enums

replace typedef dmx_caps_t dmx-caps

replace typedef dmx_filter_t dmx-filter
 
replace typedef dmx_caps_t :c:type:`dmx_caps`

replace typedef dmx_filter_t :c:type:`dmx_filter`

replace typedef dmx_pes_type_t :c:type:`dmx_pes_type`

replace typedef dmx_input_t :c:type:`dmx_input`

replace typedef dmx_source_t :c:type:`dmx_source`

Documentation/media/frontend.h.rst.exceptions

+4 −4
Original line number Diff line number Diff line
@@ -26,22 +26,22 @@ ignore define MAX_DTV_STATS 
ignore define DTV_IOCTL_MAX_MSGS



# Stats enum is documented altogether

replace enum fecap_scale_params frontend-stat-properties

replace enum fecap_scale_params :ref:`frontend-stat-properties`

replace symbol FE_SCALE_COUNTER frontend-stat-properties

replace symbol FE_SCALE_DECIBEL frontend-stat-properties

replace symbol FE_SCALE_NOT_AVAILABLE frontend-stat-properties

replace symbol FE_SCALE_RELATIVE frontend-stat-properties



# the same reference is used for both get and set ioctls

replace ioctl FE_SET_PROPERTY FE_GET_PROPERTY

replace ioctl FE_SET_PROPERTY :c:type:`FE_GET_PROPERTY`



# Ignore struct used only internally at Kernel

ignore struct dtv_cmds_h



# Typedefs that use the enum reference

replace typedef fe_sec_voltage_t fe-sec-voltage

replace typedef fe_sec_voltage_t :c:type:`fe_sec_voltage`



# Replaces for flag constants

replace define FE_TUNE_MODE_ONESHOT fe_set_frontend_tune_mode

replace define FE_TUNE_MODE_ONESHOT :c:func:`FE_SET_FRONTEND_TUNE_MODE`

replace define LNA_AUTO dtv-lna

replace define NO_STREAM_ID_FILTER dtv-stream-id

Documentation/media/intro.rst

+1 −1
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ divided into five parts. 
   called as DVB API, in fact it covers several different video standards

   including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S, DTMB, etc. The

   complete list of supported standards can be found at

   :ref:`fe-delivery-system-t`.

   :c:type:`fe_delivery_system`.



3. The :ref:`third part <remote_controllers>` covers the Remote Controller API.

CRA Git | Maintained and supported by SUSTech CRA and CCSE