diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-01 12:21:49 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-05 06:19:32 -0400 |
commit | 883dfe8ae6c7dfe4b97151094459b8a32665a168 (patch) | |
tree | 9b80186623042251a28520b6366f87b59d9162bf /Documentation/media/uapi/dvb/dmx-get-stc.rst | |
parent | 8e3195101bc24eb09def6cb3a42a37dde2c31c52 (diff) |
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>
Diffstat (limited to 'Documentation/media/uapi/dvb/dmx-get-stc.rst')
-rw-r--r-- | Documentation/media/uapi/dvb/dmx-get-stc.rst | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/Documentation/media/uapi/dvb/dmx-get-stc.rst b/Documentation/media/uapi/dvb/dmx-get-stc.rst index 6d5d069d4e6c..604031f7904b 100644 --- a/Documentation/media/uapi/dvb/dmx-get-stc.rst +++ b/Documentation/media/uapi/dvb/dmx-get-stc.rst @@ -25,18 +25,19 @@ Arguments File descriptor returned by :c:func:`open() <dvb-dmx-open>`. ``stc`` - Pointer to the location where the stc is to be stored. + Pointer to :c:type:`dmx_stc` where the stc data is to be stored. Description ----------- This ioctl call returns the current value of the system time counter -(which is driven by a PES filter of type DMX_PES_PCR). Some hardware -supports more than one STC, so you must specify which one by setting the -num field of stc before the ioctl (range 0...n). The result is returned -in form of a ratio with a 64 bit numerator and a 32 bit denominator, so -the real 90kHz STC value is stc->stc / stc->base . +(which is driven by a PES filter of type :c:type:`DMX_PES_PCR <dmx_ts_pes>`). +Some hardware supports more than one STC, so you must specify which one by +setting the :c:type:`num <dmx_stc>` field of stc before the ioctl (range 0...n). +The result is returned in form of a ratio with a 64 bit numerator +and a 32 bit denominator, so the real 90kHz STC value is +``stc->stc / stc->base``. Return Value |