From 02a3c98c6beb174022c5e46a627528be53a47755 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 1 Sep 2017 12:30:16 -0400 Subject: [PATCH] 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 --- Documentation/media/uapi/dvb/dmx-fread.rst | 7 +++++++ 1 file changed, 7 insertions(+) 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 ` flag set, + data that fails on CRC check will be silently ignored. + + Return Value ------------ -- 2.20.1