From 7ebc19752a32e42f7a8eee194c1a243b0f41121c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?N=C3=ADcolas=20F=2E=20R=2E=20A=2E=20Prado?= Date: Wed, 17 Mar 2021 16:28:27 -0300 Subject: Documentation: Fix typos and wrong rST syntax for literals MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fix some typos and some literals using ` instead of ``. Signed-off-by: Nícolas F. R. A. Prado Reviewed-by: Sebastian Fricke Reviewed-by: Laurent Pinchart Signed-off-by: Laurent Pinchart --- Documentation/guides/introduction.rst | 2 +- Documentation/guides/pipeline-handler.rst | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) (limited to 'Documentation/guides') diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst index f34d2cf7..d3a42a23 100644 --- a/Documentation/guides/introduction.rst +++ b/Documentation/guides/introduction.rst @@ -119,7 +119,7 @@ V4L2 Compatibility Layer V4L2 compatibility is achieved through a shared library that traps all accesses to camera devices and routes them to libcamera to emulate high-level V4L2 camera devices. It is injected in a process address space through - `LD_PRELOAD` and is completely transparent for applications. + ``LD_PRELOAD`` and is completely transparent for applications. The compatibility layer exposes camera device features on a best-effort basis, and aims for the level of features traditionally available from a UVC camera diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst index f4a31d3c..eb8ddfd5 100644 --- a/Documentation/guides/pipeline-handler.rst +++ b/Documentation/guides/pipeline-handler.rst @@ -177,7 +177,7 @@ configuring a build directory. .. _Meson build configuration: https://mesonbuild.com/Configuring-a-build-directory.html To add the new pipeline handler to this list of options, add its directory name -to the libcamera build options in the top level _meson_options.txt_. +to the libcamera build options in the top level ``meson_options.txt``. .. code-block:: none @@ -778,7 +778,7 @@ implementation. .. code-block:: cpp std::map> v4l2Formats = - data->video_->formats(); + data->video_->formats(); std::map> deviceFormats; std::transform(v4l2Formats.begin(), v4l2Formats.end(), std::inserter(deviceFormats, deviceFormats.begin()), @@ -1027,9 +1027,9 @@ Initializing device controls ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Pipeline handlers can optionally initialize the video devices and camera sensor -controls at system configuration time, to make sure to make sure they are -defaulted to sane values. Handling of device controls is again performed using -the libcamera `controls framework`_. +controls at system configuration time, to make sure they are defaulted to sane +values. Handling of device controls is again performed using the libcamera +`controls framework`_. .. _Controls Framework: http://libcamera.org/api-html/controls_8h.html @@ -1240,7 +1240,7 @@ Replace the stubbed contents of ``queueRequestDevice`` with the following: << "Attempt to queue request with invalid stream"; return -ENOENT; - } + } int ret = data->video_->queueBuffer(buffer); if (ret < 0) @@ -1396,7 +1396,7 @@ delivered to applications in the same order as they have been submitted. .. _connecting: http://libcamera.org/api-html/classlibcamera_1_1Signal.html#aa04db72d5b3091ffbb4920565aeed382 Returning to the ``int VividCameraData::init()`` method, add the following above -the closing ``return 0;`` to connects the pipeline handler ``bufferReady`` +the closing ``return 0;`` to connect the pipeline handler ``bufferReady`` method to the V4L2 device buffer signal. .. code-block:: cpp @@ -1428,7 +1428,7 @@ code-base. Testing a pipeline handler ~~~~~~~~~~~~~~~~~~~~~~~~~~ -Once you've built the pipeline handler, we ca rebuild the code base, and test +Once you've built the pipeline handler, we can rebuild the code base, and test capture through the pipeline through both of the cam and qcam utilities. .. code-block:: shell -- cgit v1.2.1