From patchwork Wed May 4 14:48:20 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Quentin Schulz X-Patchwork-Id: 15779 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id C6AE1C0F2A for ; Wed, 4 May 2022 14:48:35 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 120B765648; Wed, 4 May 2022 16:48:35 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1651675715; bh=L18YCJ2PZG2MeUEvJfF1fS3bexr93LB6idbz4Gksdvg=; h=To:Date:Subject:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:Cc:From; b=n8f5R5q65iV7TdDeCHYiR5mO1SkJA+vtahEaqyZ65HuX5EXmvWaooKEbfJbS/Db2N 2sHPC9P6dsRy383CRAM+Al9Z5IXnOWxd8+YPN5ykiyNqJPuZwSonjYskuz99sSF7DZ hc3QsOG7+gdhbXd/qDR7qgb9Obvethuu4jRKqb8+cGq3Gd3lMRpjlLcy9GCCKljQ4D nAd2mDOagpxqEo0mcX3V5++6PjFIYo7mjIdI+IUUheJOJfvaOwaLykObHvcoZX26ri BiocgjBV7Is9edIHUTyw4Fn/yY66fl61cPqO59aGiXd2iy2VIadd9D7B8Co3mdZ2AB ixXokj3ianpIg== Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [IPv6:2001:4b98:dc4:8::226]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id F388D604A4 for ; Wed, 4 May 2022 16:48:33 +0200 (CEST) Received: (Authenticated sender: foss@0leil.net) by mail.gandi.net (Postfix) with ESMTPSA id CC73CC0013; Wed, 4 May 2022 14:48:32 +0000 (UTC) To: Date: Wed, 4 May 2022 16:48:20 +0200 Message-Id: <20220504144822.63576-1-foss+libcamera@0leil.net> X-Mailer: git-send-email 2.35.1 MIME-Version: 1.0 Subject: [libcamera-devel] =?utf-8?q?=5BPATCH_v2_1/3=5D_Documentation=3A_r?= =?utf-8?b?ZXBsYWNlIOKAmSBieSAn?= X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Quentin Schulz via libcamera-devel From: Quentin Schulz Reply-To: Quentin Schulz Cc: libcamera-devel@lists.libcamera.org Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" From: Quentin Schulz Replace U+2019 unicode character (’; right single quotation mark) by U+27 unicode character ('; apostrophe) as it is what most people are used to in sentences. While Sphinx seems to be rendering both the same way, it makes it easier for searching in rST files directly. Reviewed-by: Jacopo Mondi Reviewed-by: Laurent Pinchart Cc: Quentin Schulz Signed-off-by: Quentin Schulz --- Documentation/guides/application-developer.rst | 10 +++++----- Documentation/guides/introduction.rst | 2 +- Documentation/guides/pipeline-handler.rst | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst index cafb24b1..07cc7273 100644 --- a/Documentation/guides/application-developer.rst +++ b/Documentation/guides/application-developer.rst @@ -47,7 +47,7 @@ runs for the life of the application. When the Camera Manager starts, it enumerates all the cameras detected in the system. Behind the scenes, libcamera abstracts and manages the complex pipelines that kernel drivers expose through the `Linux Media Controller`_ and `Video for Linux`_ (V4L2) APIs, meaning that -an application doesn’t need to handle device or driver specific details. +an application doesn't need to handle device or driver specific details. .. _CameraManager: http://libcamera.org/api-html/classlibcamera_1_1CameraManager.html .. _Linux Media Controller: https://www.kernel.org/doc/html/latest/media/uapi/mediactl/media-controller-intro.html @@ -236,8 +236,8 @@ applied to the system. camera->configure(config.get()); -If an application doesn’t first validate the configuration before calling -``Camera::configure()``, there’s a chance that calling the function can fail, if +If an application doesn't first validate the configuration before calling +``Camera::configure()``, there's a chance that calling the function can fail, if the given configuration would have to be adjusted. Allocate FrameBuffers @@ -259,7 +259,7 @@ of suitable buffers, for instance, when no other device is involved, or on Linux platforms that lack a centralized allocator. The ``FrameBufferAllocator`` class provides a buffer allocator an application can use in these situations. -An application doesn’t have to use the default ``FrameBufferAllocator`` that +An application doesn't have to use the default ``FrameBufferAllocator`` that libcamera provides. It can instead allocate memory manually and pass the buffers in ``Request``\s (read more about ``Request`` in `the frame capture section <#frame-capture>`_ of this guide). The example in this guide covers using the @@ -392,7 +392,7 @@ Create the ``requestComplete`` function by matching the slot signature: Request completion events can be emitted for requests which have been canceled, for example, by unexpected application shutdown. To avoid an application -processing invalid image data, it’s worth checking that the request has +processing invalid image data, it's worth checking that the request has completed successfully. The list of request completion statuses is available in the `Request::Status`_ class enum documentation. diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst index a4671a07..d080679f 100644 --- a/Documentation/guides/introduction.rst +++ b/Documentation/guides/introduction.rst @@ -150,7 +150,7 @@ Architecture ------------ While offering a unified API towards upper layers, and presenting itself as a -single library, libcamera isn’t monolithic. It exposes multiple components +single library, libcamera isn't monolithic. It exposes multiple components through its public API and is built around a set of separate helpers internally. Hardware abstractions are handled through the use of device-specific components where required and dynamically loadable plugins are used to separate image diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst index c0fb7147..a7208f57 100644 --- a/Documentation/guides/pipeline-handler.rst +++ b/Documentation/guides/pipeline-handler.rst @@ -1036,8 +1036,8 @@ values. Handling of device controls is again performed using the libcamera .. _Controls Framework: http://libcamera.org/api-html/controls_8h.html This section is particularly specific to Vivid as it sets the initial values of -controls to match `Vivid Controls`_ defined by the kernel driver. You won’t need -any of the code below for your pipeline handler, but it’s included as an example +controls to match `Vivid Controls`_ defined by the kernel driver. You won't need +any of the code below for your pipeline handler, but it's included as an example of how to implement functionality your pipeline handler might need. .. _Vivid Controls: https://www.kernel.org/doc/html/latest/admin-guide/media/vivid.html#controls