From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756101AbdJJLpg (ORCPT ); Tue, 10 Oct 2017 07:45:36 -0400 Received: from osg.samsung.com ([64.30.133.232]:57389 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755272AbdJJLpd (ORCPT ); Tue, 10 Oct 2017 07:45:33 -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 , Hans Verkuil , Sakari Ailus Subject: [PATCH v8 5/7] media: open.rst: Adjust some terms to match the glossary Date: Tue, 10 Oct 2017 08:45:21 -0300 Message-Id: <57ad7d66ae6c9de96cae48cecc77137a0970bab6.1507635716.git.mchehab@s-opensource.com> X-Mailer: git-send-email 2.13.6 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 As we now have a glossary, some terms used on open.rst require adjustments. Acked-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab --- Documentation/media/uapi/v4l/open.rst | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/Documentation/media/uapi/v4l/open.rst b/Documentation/media/uapi/v4l/open.rst index 1a8a9e1d0e84..c9e6bc9280a6 100644 --- a/Documentation/media/uapi/v4l/open.rst +++ b/Documentation/media/uapi/v4l/open.rst @@ -159,27 +159,28 @@ Related Devices Devices can support several functions. For example video capturing, VBI capturing and radio support. -The V4L2 API creates different nodes for each of these functions. +The V4L2 API creates different :term:`V4L2 device nodes ` +types for each of these functions. -The V4L2 API was designed with the idea that one device node could +The V4L2 API was designed with the idea that one :term:`device node` could support all functions. However, in practice this never worked: this -'feature' was never used by applications and many drivers did not -support it and if they did it was certainly never tested. In addition, +'feature' was never used by applications and many :term:`drivers ` +did not support it and if they did it was certainly never tested. In addition, switching a device node between different functions only works when using the streaming I/O API, not with the :ref:`read() `/\ :ref:`write() ` API. -Today each device node supports just one function. +Today each V4L2 device node supports just one function. -Besides video input or output the hardware may also support audio -sampling or playback. If so, these functions are implemented as ALSA PCM -devices with optional ALSA audio mixer devices. +Besides video input or output, the :term:`media hardware` may also support +audio sampling or playback. If so, these functions are implemented as ALSA +PCM devices with optional ALSA audio mixer devices. One problem with all these devices is that the V4L2 API makes no -provisions to find these related devices. Some really complex devices -use the Media Controller (see :ref:`media_controller`) which can be -used for this purpose. But most drivers do not use it, and while some -code exists that uses sysfs to discover related devices (see +provisions to find these related V4L2 device nodes. Some really complex +hardware use the :term:`media controller` (see :ref:`media_controller`) which +can be used for this purpose. But several drivers do not use it, and while +some code exists that uses sysfs to discover related V4L2 device nodes (see libmedia_dev in the `v4l-utils `__ git repository), there is no library yet that can provide a single API -- 2.13.6