Commit 02a3c98c authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

media: dmx-fread.rst: specify how DMX_CHECK_CRC works

In the past, the documentation used to say that, if a CRC error
was found, a "-ECRC" error would be returned. That's not true:
the DVB core will just silently ignore such errors.

So, add an explicit note about that.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 699f19e3
...@@ -38,6 +38,13 @@ data. The filtered data is transferred from the driver’s internal ...@@ -38,6 +38,13 @@ data. The filtered data is transferred from the driver’s internal
circular buffer to buf. The maximum amount of data to be transferred is circular buffer to buf. The maximum amount of data to be transferred is
implied by count. implied by count.
.. note::
if a section filter created with
:c:type:`DMX_CHECK_CRC <dmx_sct_filter_params>` flag set,
data that fails on CRC check will be silently ignored.
Return Value Return Value
------------ ------------
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment