linux/Documentation/media/uapi/dvb
Mauro Carvalho Chehab 883dfe8ae6 media: dvb uAPI docs: minor editorial changes
Do minor editorial changes to improve documentation readability:

- mark literals as such;
- add table markups to hint sizes;
- define what PES means;
- instead of hardcoding devnode numbers to zero (like adapter0/) use a
  question mark, to indicate that multiple devnodes may exist;
- add cross-references where useful.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-05 06:19:32 -04:00
..
audio_data_types.rst [media] docs-rst exceptions: use C domain references for DVB headers 2016-09-09 09:45:24 -03:00
audio_function_calls.rst
audio-bilingual-channel-select.rst [media] docs-rst exceptions: use C domain references for DVB headers 2016-09-09 09:45:24 -03:00
audio-channel-select.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
audio-clear-buffer.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-continue.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-fclose.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
audio-fopen.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
audio-fwrite.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
audio-get-capabilities.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-get-pts.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-get-status.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-pause.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-play.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-select-source.rst [media] docs-rst exceptions: use C domain references for DVB headers 2016-09-09 09:45:24 -03:00
audio-set-attributes.rst [media] docs-rst exceptions: use C domain references for DVB headers 2016-09-09 09:45:24 -03:00
audio-set-av-sync.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
audio-set-bypass-mode.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
audio-set-ext-id.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-set-id.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-set-karaoke.rst [media] docs-rst exceptions: use C domain references for DVB headers 2016-09-09 09:45:24 -03:00
audio-set-mixer.rst [media] docs-rst exceptions: use C domain references for DVB headers 2016-09-09 09:45:24 -03:00
audio-set-mute.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
audio-set-streamtype.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio-stop.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
audio.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
ca_data_types.rst media: dvb CA docs: place undocumented data together with ioctls 2017-09-05 06:12:54 -04:00
ca_function_calls.rst media: ca.h: get rid of CA_SET_PID 2017-09-05 06:06:56 -04:00
ca-fclose.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
ca-fopen.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
ca-get-cap.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
ca-get-descr-info.rst media: ca-get-descr-info.rst: document this ioctl 2017-09-05 06:12:35 -04:00
ca-get-msg.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
ca-get-slot-info.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
ca-reset.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
ca-send-msg.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
ca-set-descr.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
ca.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
demux.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
dmx_fcalls.rst media: dmx.h: get rid of GET_DMX_EVENT 2017-09-05 06:02:20 -04:00
dmx_types.rst media: dmx.h: add kernel-doc markups and use it at Documentation/ 2017-09-05 06:05:40 -04:00
dmx-add-pid.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dmx-fclose.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dmx-fopen.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dmx-fread.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dmx-fwrite.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dmx-get-pes-pids.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
dmx-get-stc.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dmx-remove-pid.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dmx-set-buffer-size.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dmx-set-filter.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dmx-set-pes-filter.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
dmx-start.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
dmx-stop.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dvb-fe-read-status.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
dvb-frontend-event.rst [media] docs-rst: convert uAPI structs to C domain 2016-09-09 09:34:01 -03:00
dvb-frontend-parameters.rst media: dvb-frontend-parameters.rst: fix the name of a struct 2017-09-05 06:18:47 -04:00
dvbapi.rst media: dvbapi.rst: add an entry to DVB revision history 2017-09-05 06:19:04 -04:00
dvbproperty.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
dvbstb.svg media: svg files: simplify files 2017-07-18 11:53:43 -03:00
examples.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
fe_property_parameters.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
fe-bandwidth-t.rst [media] docs-rst exceptions: use C domain references for DVB headers 2016-09-09 09:45:24 -03:00
fe-diseqc-recv-slave-reply.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-diseqc-reset-overload.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
fe-diseqc-send-burst.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-diseqc-send-master-cmd.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
fe-dishnetwork-send-legacy-cmd.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-enable-high-lnb-voltage.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-get-event.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-get-frontend.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-get-info.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
fe-get-property.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
fe-read-ber.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-read-signal-strength.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-read-snr.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-read-status.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
fe-read-uncorrected-blocks.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-set-frontend-tune-mode.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
fe-set-frontend.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-set-tone.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-set-voltage.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
fe-type-t.rst media: dvb uAPI docs: minor editorial changes 2017-09-05 06:19:32 -04:00
frontend_f_close.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
frontend_f_open.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
frontend_fcalls.rst
frontend_legacy_api.rst
frontend_legacy_dvbv3_api.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
frontend-header.rst media: dvb frontend docs: use kernel-doc documentation 2017-09-05 05:57:35 -04:00
frontend-property-cable-systems.rst
frontend-property-satellite-systems.rst
frontend-property-terrestrial-systems.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
frontend-stat-properties.rst [media] docs-rst: convert uAPI structs to C domain 2016-09-09 09:34:01 -03:00
frontend.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
headers.rst media: dvb uapi docs: better organize header files 2017-09-05 06:14:16 -04:00
intro.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
legacy_dvb_apis.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
net-add-if.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
net-get-if.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
net-remove-if.rst media: dvb uAPI docs: adjust return value ioctl descriptions 2017-09-05 06:16:37 -04:00
net.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
query-dvb-frontend-info.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
video_function_calls.rst
video_types.rst [media] docs-rst: convert uAPI structs to C domain 2016-09-09 09:34:01 -03:00
video-clear-buffer.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-command.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-continue.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
video-fast-forward.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-fclose.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-fopen.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-freeze.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
video-fwrite.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-get-capabilities.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-get-event.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
video-get-frame-count.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-get-frame-rate.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-get-navi.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-get-pts.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-get-size.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-get-status.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-play.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
video-select-source.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
video-set-attributes.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-set-blank.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-set-display-format.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-set-format.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-set-highlight.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-set-id.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-set-spu-palette.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-set-spu.rst [media] fix broken references on dvb/video*rst 2016-09-09 09:53:35 -03:00
video-set-streamtype.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-set-system.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-slowmotion.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-stillpicture.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video-stop.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00
video-try-command.rst [media] docs-rst: Convert DVB uAPI to use C function references 2016-08-22 21:23:34 -03:00
video.rst media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 2017-09-05 06:18:03 -04:00