summaryrefslogtreecommitdiff
path: root/Documentation/media
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-01 19:30:16 +0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-05 13:18:28 +0300
commit02a3c98c6beb174022c5e46a627528be53a47755 (patch)
treec4c25f9de4c42514f39032040101055d99d5d468 /Documentation/media
parent699f19e3f1e84e7e0ce3b2be7ceafe4ce99b606e (diff)
downloadlinux-02a3c98c6beb174022c5e46a627528be53a47755.tar.xz
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media')
-rw-r--r--Documentation/media/uapi/dvb/dmx-fread.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/media/uapi/dvb/dmx-fread.rst b/Documentation/media/uapi/dvb/dmx-fread.rst
index cb6cedbb47f6..36ba851bc0af 100644
--- a/Documentation/media/uapi/dvb/dmx-fread.rst
+++ b/Documentation/media/uapi/dvb/dmx-fread.rst
@@ -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
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
------------