From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752396AbdIAN1P (ORCPT ); Fri, 1 Sep 2017 09:27:15 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:46998 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1752126AbdIANZE (ORCPT ); Fri, 1 Sep 2017 09:25:04 -0400 X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Linux Media Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet Subject: [PATCH v2 26/27] media: dvb rst: identify the documentation gap at the API Date: Fri, 1 Sep 2017 10:24:48 -0300 Message-Id: <45073d226a002d80218abcf49c1ac8c5b5246260.1504272067.git.mchehab@s-opensource.com> X-Mailer: git-send-email 2.13.5 In-Reply-To: References: In-Reply-To: References: Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Now that DVB spec is almost in sync, document what's missing. Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/uapi/dvb/ca.rst | 5 +++++ Documentation/media/uapi/dvb/legacy_dvb_apis.rst | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/Documentation/media/uapi/dvb/ca.rst b/Documentation/media/uapi/dvb/ca.rst index 14b14abda1ae..e3de778a5678 100644 --- a/Documentation/media/uapi/dvb/ca.rst +++ b/Documentation/media/uapi/dvb/ca.rst @@ -10,6 +10,11 @@ accessed through ``/dev/dvb/adapter?/ca?``. Data types and and ioctl definitions can be accessed by including ``linux/dvb/ca.h`` in your application. +.. note:: + + There are three ioctls at this API that aren't documented: + :ref:`CA_GET_MSG`, :ref:`CA_SEND_MSG` and :ref:`CA_SET_DESCR`. + Documentation for them are welcome. .. toctree:: :maxdepth: 1 diff --git a/Documentation/media/uapi/dvb/legacy_dvb_apis.rst b/Documentation/media/uapi/dvb/legacy_dvb_apis.rst index 2957f5a988b0..dac349a1bb27 100644 --- a/Documentation/media/uapi/dvb/legacy_dvb_apis.rst +++ b/Documentation/media/uapi/dvb/legacy_dvb_apis.rst @@ -12,6 +12,11 @@ drivers should use it. Instead, audio and video should be using the V4L2 and ALSA APIs, and the pipelines should be set using the Media Controller API +.. note:: + + The APIs described here doesn't necessarily reflect the current + code implementation. + .. toctree:: :maxdepth: 1 -- 2.13.5