[{"id":15751,"web_url":"https://patchwork.libcamera.org/comment/15751/","msgid":"<20210318050947.pwa6khb4d7hr7dzu@basti-TUXEDO-Book-XA1510>","date":"2021-03-18T05:09:47","subject":"Re: [libcamera-devel] [PATCH 1/5] Documentation: Fix typos and\n\twrong rST syntax for literals","submitter":{"id":78,"url":"https://patchwork.libcamera.org/api/people/78/","name":"Sebastian Fricke","email":"sebastian.fricke@posteo.net"},"content":"Hey Nícolas,\n\nOn 17.03.2021 16:28, Nícolas F. R. A. Prado wrote:\n>Fix some typos and some literals using ` instead of ``.\n\nThank you for the patch.\nThis looks good, I only found a single change that goes against our\ncoding style guidelines. With that fixed..\n\nReviewed-by: Sebastian Fricke \n>\n>Signed-off-by: Nícolas F. R. A. Prado \n>---\n> Documentation/environment_variables.rst | 21 ++++++++++----------\n> Documentation/guides/introduction.rst | 2 +-\n> Documentation/guides/pipeline-handler.rst | 13 ++++++------\n> Documentation/sensor_driver_requirements.rst | 12 +++++------\n> README.rst | 6 +++---\n> 5 files changed, 27 insertions(+), 27 deletions(-)\n>\n>diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst\n>index 01294d79b9a8..e482c98e5f30 100644\n>--- a/Documentation/environment_variables.rst\n>+++ b/Documentation/environment_variables.rst\n>@@ -35,10 +35,11 @@ Further details\n> Notes about debugging\n> ~~~~~~~~~~~~~~~~~~~~~\n>\n>-The environment variables `LIBCAMERA_LOG_FILE` and `LIBCAMERA_LOG_LEVELS` are\n>-used to modify the destination and verbosity of messages provided by libcamera.\n>+The environment variables ``LIBCAMERA_LOG_FILE`` and ``LIBCAMERA_LOG_LEVELS``\n>+are used to modify the destination and verbosity of messages provided by\n>+libcamera.\n>\n>-The `LIBCAMERA_LOG_LEVELS` variable accepts a comma-separated list of\n>+The ``LIBCAMERA_LOG_LEVELS`` variable accepts a comma-separated list of\n> 'category:level' pairs.\n>\n> The `level <#log-levels>`__ part is mandatory and can either be specified by\n>@@ -61,8 +62,8 @@ within a local environment:\n> LIBCAMERA_LOG_LEVELS=0 \\\n> cam --list\n>\n>-Enable full debug output for the categories `Camera` and `V4L2` within a global\n>-environment:\n>+Enable full debug output for the categories ``Camera`` and ``V4L2`` within a\n>+global environment:\n>\n> .. code:: bash\n>\n>@@ -100,10 +101,10 @@ There are two available macros used to assign a category name to a part of the\n> libcamera codebase:\n>\n> LOG_DEFINE_CATEGORY\n>- This macro is required, in order to use the `LOGC` macro for a particular\n>+ This macro is required, in order to use the ``LOGC`` macro for a particular\n> category. It can only be used once for each category. If you want to create\n> log messages within multiple compilation units for the same category utilize\n>- the `LOG_DECLARE_CATEGORY` macro, in every file except the definition file.\n>+ the ``LOG_DECLARE_CATEGORY`` macro, in every file except the definition file.\n> LOG_DECLARE_CATEGORY\n> Used for sharing an already defined category between multiple separate\n> compilation units.\n>@@ -118,7 +119,7 @@ IPA modules use configuration files to store parameters. The format and\n> contents of the configuration files is specific to the IPA module. They usually\n> contain tuning parameters for the algorithms, in JSON format.\n>\n>-The `LIBCAMERA_IPA_CONFIG_PATH` variable can be used to specify custom\n>+The ``LIBCAMERA_IPA_CONFIG_PATH`` variable can be used to specify custom\n> storage locations to search for those configuration files.\n>\n> `Examples `__\n>@@ -130,5 +131,5 @@ In order to locate the correct IPA module for your hardware, libcamera gathers\n> existing IPA modules from multiple locations. The default locations for this\n> operation are the installed system path (for example on Debian:\n> ``/usr/local/x86_64-pc-linux-gnu/libcamera``) and the build directory.\n>-With the `LIBCAMERA_IPA_MODULE_PATH`, you can specify a non-default\n>-location to search for IPA modules.\n>+With the ``LIBCAMERA_IPA_MODULE_PATH``, you can specify a non-default location\n>+to search for IPA modules.\n>diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst\n>index f34d2cf7cbdc..d3a42a23fa8c 100644\n>--- a/Documentation/guides/introduction.rst\n>+++ b/Documentation/guides/introduction.rst\n>@@ -119,7 +119,7 @@ V4L2 Compatibility Layer\n> V4L2 compatibility is achieved through a shared library that traps all\n> accesses to camera devices and routes them to libcamera to emulate high-level\n> V4L2 camera devices. It is injected in a process address space through\n>- `LD_PRELOAD` and is completely transparent for applications.\n>+ ``LD_PRELOAD`` and is completely transparent for applications.\n>\n> The compatibility layer exposes camera device features on a best-effort basis,\n> and aims for the level of features traditionally available from a UVC camera\n>diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\n>index f4a31d3c9588..43783ec32afa 100644\n>--- a/Documentation/guides/pipeline-handler.rst\n>+++ b/Documentation/guides/pipeline-handler.rst\n>@@ -177,7 +177,7 @@ configuring a build directory.\n> .. _Meson build configuration: https://mesonbuild.com/Configuring-a-build-directory.html\n>\n> To add the new pipeline handler to this list of options, add its directory name\n>-to the libcamera build options in the top level _meson_options.txt_.\n>+to the libcamera build options in the top level ``meson_options.txt``.\n>\n> .. code-block:: none\n>\n>@@ -777,8 +777,7 @@ implementation.\n>\n> .. code-block:: cpp\n>\n>- std::map> v4l2Formats =\n>- data->video_->formats();\n>+ std::map> v4l2Formats = data->video_->formats();\n\nWe generally try to keep the 80 column limit for the code as well as the\ndocumentation. This line is now 91 columns long.\n\nQuote:\n```\n* 2 \"Breaking Long Lines\" striving to fit code within 80 columns and\n accepting up to 120 columns when necessary\n```\nI am not sure if this should be declared necessary.\n\n> std::map> deviceFormats;\n> std::transform(v4l2Formats.begin(), v4l2Formats.end(),\n> std::inserter(deviceFormats, deviceFormats.begin()),\n>@@ -1027,7 +1026,7 @@ Initializing device controls\n> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n>\n> Pipeline handlers can optionally initialize the video devices and camera sensor\n>-controls at system configuration time, to make sure to make sure they are\n>+controls at system configuration time, to make sure they are\n> defaulted to sane values. Handling of device controls is again performed using\n> the libcamera `controls framework`_.\n>\n>@@ -1240,7 +1239,7 @@ Replace the stubbed contents of ``queueRequestDevice`` with the following:\n> << \"Attempt to queue request with invalid stream\";\n>\n> return -ENOENT;\n>- }\n>+ }\n>\n> int ret = data->video_->queueBuffer(buffer);\n> if (ret < 0)\n>@@ -1396,7 +1395,7 @@ delivered to applications in the same order as they have been submitted.\n> .. _connecting: http://libcamera.org/api-html/classlibcamera_1_1Signal.html#aa04db72d5b3091ffbb4920565aeed382\n>\n> Returning to the ``int VividCameraData::init()`` method, add the following above\n>-the closing ``return 0;`` to connects the pipeline handler ``bufferReady``\n>+the closing ``return 0;`` to connect the pipeline handler ``bufferReady``\n> method to the V4L2 device buffer signal.\n>\n> .. code-block:: cpp\n>@@ -1428,7 +1427,7 @@ code-base.\n> Testing a pipeline handler\n> ~~~~~~~~~~~~~~~~~~~~~~~~~~\n>\n>-Once you've built the pipeline handler, we ca rebuild the code base, and test\n>+Once you've built the pipeline handler, we can rebuild the code base, and test\n> capture through the pipeline through both of the cam and qcam utilities.\n>\n> .. code-block:: shell\n>diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst\n>index 17841ddda5f5..3e800c8e9c13 100644\n>--- a/Documentation/sensor_driver_requirements.rst\n>+++ b/Documentation/sensor_driver_requirements.rst\n>@@ -34,13 +34,13 @@ For RAW sensors, the sensor driver shall support the following V4L2 controls:\n> .. _V4L2_CID_PIXEL_RATE: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-image-process.html\n> .. _V4L2_CID_VBLANK: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-image-source.html\n>\n>-While V4L2 doesn't specify a unit for the `EXPOSURE` control, libcamera requires\n>-it to be expressed as a number of image lines. Camera sensor drivers that do not\n>-comply with this requirement will need to be adapted or will produce incorrect\n>-results.\n>+While V4L2 doesn't specify a unit for the ``EXPOSURE`` control, libcamera\n>+requires it to be expressed as a number of image lines. Camera sensor drivers\n>+that do not comply with this requirement will need to be adapted or will produce\n>+incorrect results.\n>\n>-The `HBLANK`, `PIXEL_RATE` and `VBLANK` controls are used to compute the sensor\n>-output timings.\n>+The ``HBLANK``, ``PIXEL_RATE`` and ``VBLANK`` controls are used to compute the\n>+sensor output timings.\n>\n> Optional Requirements\n> ---------------------\n>diff --git a/README.rst b/README.rst\n>index b48455ab4e67..427dbe9cd798 100644\n>--- a/README.rst\n>+++ b/README.rst\n>@@ -95,9 +95,9 @@ GStreamer can find it.\n>\n> export GST_PLUGIN_PATH=$(pwd)/build/src/gstreamer\n>\n>-The debugging tool `gst-launch-1.0` can be used to construct and pipeline and test\n>-it. The following pipeline will stream from the camera named \"Camera 1\" onto the\n>-default video display element on your system.\n>+The debugging tool ``gst-launch-1.0`` can be used to construct and pipeline and\n>+test it. The following pipeline will stream from the camera named \"Camera 1\"\n>+onto the default video display element on your system.\n>\n> .. code::\n>\n>-- \n>2.30.2\n>\n>_______________________________________________\n>libcamera-devel mailing list\n>libcamera-devel@lists.libcamera.org\n>https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id CF1C0BD80C\n\tfor ;\n\tThu, 18 Mar 2021 05:09:50 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 489B068D61;\n\tThu, 18 Mar 2021 06:09:50 +0100 (CET)","from mout02.posteo.de (mout02.posteo.de [185.67.36.66])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id A99226051E\n\tfor ;\n\tThu, 18 Mar 2021 06:09:48 +0100 (CET)","from submission (posteo.de [89.146.220.130]) \n\tby mout02.posteo.de (Postfix) with ESMTPS id 263E52400FC\n\tfor ;\n\tThu, 18 Mar 2021 06:09:48 +0100 (CET)","from customer (localhost [127.0.0.1])\n\tby submission (posteo.de) with ESMTPSA id 4F1FSq4Vbxz6tmM;\n\tThu, 18 Mar 2021 06:09:47 +0100 (CET)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (2048-bit key;\n\tunprotected) header.d=posteo.net header.i=@posteo.net\n\theader.b=\"G58SCCVo\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017;\n\tt=1616044188; bh=6SIbKAe/KAA0VlcQMPoULHrNQBkQUz7JWAD1bx9slLg=;\n\th=Date:From:To:Cc:Subject:From;\n\tb=G58SCCVo+hyb0etiFcXs4LwP7w7Tpya+wqVZc/GHvOSBTjSesMjnA9z2m1Acs7J+9\n\trhGu02w2lnRISomg+7nHrMwxJjXIOb2d0DGVdZgG6Vs1oJjKa2py5Oj9Z3P/IzZiM6\n\tAOXfc3+ZZGSYQVn/vnLRdKpz7SiBr0mePVdl+GPE+U3VVy8SxpvXShtqZp8oArkBza\n\tiN6rynQkVLxTbyYopZgVfX476sbhsa4P72xsMRfn5fWX7SqdQOf1VJDkdgqdLw01AG\n\tZuwHoV1/voNI1zl4SsxMoQ6ZzPU06Q1ypiCisFTeoTwFFIm6zyb6aaM3qU/Tg387vN\n\tzDZ3LTE9xjyqw==","Date":"Thu, 18 Mar 2021 06:09:47 +0100","From":"Sebastian Fricke ","To":"=?utf-8?b?TsOtY29sYXMgRi4gUi4gQS4=?= Prado ","Message-ID":"<20210318050947.pwa6khb4d7hr7dzu@basti-TUXEDO-Book-XA1510>","References":"<20210317192831.359014-1-nfraprado@collabora.com>\n\t<20210317192831.359014-2-nfraprado@collabora.com>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20210317192831.359014-2-nfraprado@collabora.com>","Subject":"Re: [libcamera-devel] [PATCH 1/5] Documentation: Fix typos and\n\twrong rST syntax for literals","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Cc":"Chris Chinchilla ,\n\tSebastian Fricke ,\n\tlibcamera-devel@lists.libcamera.org","Content-Transfer-Encoding":"base64","Content-Type":"text/plain; charset=\"utf-8\"; Format=\"flowed\"","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":15760,"web_url":"https://patchwork.libcamera.org/comment/15760/","msgid":"","date":"2021-03-18T23:52:38","subject":"Re: [libcamera-devel] [PATCH 1/5] Documentation: Fix typos and\n\twrong rST syntax for literals","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Nicolas,\n\nThank you for the patch.\n\nOn Thu, Mar 18, 2021 at 06:09:47AM +0100, Sebastian Fricke wrote:\n> On 17.03.2021 16:28, Nícolas F. R. A. Prado wrote:\n> > Fix some typos and some literals using ` instead of ``.\n> \n> Thank you for the patch.\n> This looks good, I only found a single change that goes against our\n> coding style guidelines. With that fixed..\n> \n> Reviewed-by: Sebastian Fricke \n> >\n> > Signed-off-by: Nícolas F. R. A. Prado \n> > ---\n> > Documentation/environment_variables.rst | 21 ++++++++++----------\n> > Documentation/guides/introduction.rst | 2 +-\n> > Documentation/guides/pipeline-handler.rst | 13 ++++++------\n> > Documentation/sensor_driver_requirements.rst | 12 +++++------\n> > README.rst | 6 +++---\n> > 5 files changed, 27 insertions(+), 27 deletions(-)\n> > \n> > diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst\n> > index 01294d79b9a8..e482c98e5f30 100644\n> > --- a/Documentation/environment_variables.rst\n> > +++ b/Documentation/environment_variables.rst\n> > @@ -35,10 +35,11 @@ Further details\n> > Notes about debugging\n> > ~~~~~~~~~~~~~~~~~~~~~\n> > \n> > -The environment variables `LIBCAMERA_LOG_FILE` and `LIBCAMERA_LOG_LEVELS` are\n> > -used to modify the destination and verbosity of messages provided by libcamera.\n> > +The environment variables ``LIBCAMERA_LOG_FILE`` and ``LIBCAMERA_LOG_LEVELS``\n> > +are used to modify the destination and verbosity of messages provided by\n> > +libcamera.\n> > \n> > -The `LIBCAMERA_LOG_LEVELS` variable accepts a comma-separated list of\n> > +The ``LIBCAMERA_LOG_LEVELS`` variable accepts a comma-separated list of\n> > 'category:level' pairs.\n> > \n> > The `level <#log-levels>`__ part is mandatory and can either be specified by\n> > @@ -61,8 +62,8 @@ within a local environment:\n> > LIBCAMERA_LOG_LEVELS=0 \\\n> > cam --list\n> > \n> > -Enable full debug output for the categories `Camera` and `V4L2` within a global\n> > -environment:\n> > +Enable full debug output for the categories ``Camera`` and ``V4L2`` within a\n> > +global environment:\n> > \n> > .. code:: bash\n> > \n> > @@ -100,10 +101,10 @@ There are two available macros used to assign a category name to a part of the\n> > libcamera codebase:\n> > \n> > LOG_DEFINE_CATEGORY\n> > - This macro is required, in order to use the `LOGC` macro for a particular\n> > + This macro is required, in order to use the ``LOGC`` macro for a particular\n> > category. It can only be used once for each category. If you want to create\n> > log messages within multiple compilation units for the same category utilize\n> > - the `LOG_DECLARE_CATEGORY` macro, in every file except the definition file.\n> > + the ``LOG_DECLARE_CATEGORY`` macro, in every file except the definition file.\n> > LOG_DECLARE_CATEGORY\n> > Used for sharing an already defined category between multiple separate\n> > compilation units.\n> > @@ -118,7 +119,7 @@ IPA modules use configuration files to store parameters. The format and\n> > contents of the configuration files is specific to the IPA module. They usually\n> > contain tuning parameters for the algorithms, in JSON format.\n> > \n> > -The `LIBCAMERA_IPA_CONFIG_PATH` variable can be used to specify custom\n> > +The ``LIBCAMERA_IPA_CONFIG_PATH`` variable can be used to specify custom\n> > storage locations to search for those configuration files.\n> > \n> > `Examples `__\n> > @@ -130,5 +131,5 @@ In order to locate the correct IPA module for your hardware, libcamera gathers\n> > existing IPA modules from multiple locations. The default locations for this\n> > operation are the installed system path (for example on Debian:\n> > ``/usr/local/x86_64-pc-linux-gnu/libcamera``) and the build directory.\n> > -With the `LIBCAMERA_IPA_MODULE_PATH`, you can specify a non-default\n> > -location to search for IPA modules.\n> > +With the ``LIBCAMERA_IPA_MODULE_PATH``, you can specify a non-default location\n> > +to search for IPA modules.\n> > diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst\n> > index f34d2cf7cbdc..d3a42a23fa8c 100644\n> > --- a/Documentation/guides/introduction.rst\n> > +++ b/Documentation/guides/introduction.rst\n> > @@ -119,7 +119,7 @@ V4L2 Compatibility Layer\n> > V4L2 compatibility is achieved through a shared library that traps all\n> > accesses to camera devices and routes them to libcamera to emulate high-level\n> > V4L2 camera devices. It is injected in a process address space through\n> > - `LD_PRELOAD` and is completely transparent for applications.\n> > + ``LD_PRELOAD`` and is completely transparent for applications.\n> > \n> > The compatibility layer exposes camera device features on a best-effort basis,\n> > and aims for the level of features traditionally available from a UVC camera\n> > diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\n> > index f4a31d3c9588..43783ec32afa 100644\n> > --- a/Documentation/guides/pipeline-handler.rst\n> > +++ b/Documentation/guides/pipeline-handler.rst\n> > @@ -177,7 +177,7 @@ configuring a build directory.\n> > .. _Meson build configuration: https://mesonbuild.com/Configuring-a-build-directory.html\n> > \n> > To add the new pipeline handler to this list of options, add its directory name\n> > -to the libcamera build options in the top level _meson_options.txt_.\n> > +to the libcamera build options in the top level ``meson_options.txt``.\n> > \n> > .. code-block:: none\n> > \n> > @@ -777,8 +777,7 @@ implementation.\n> > \n> > .. code-block:: cpp\n> > \n> > - std::map> v4l2Formats =\n> > - data->video_->formats();\n> > + std::map> v4l2Formats = data->video_->formats();\n> \n> We generally try to keep the 80 column limit for the code as well as the\n> documentation. This line is now 91 columns long.\n> \n> Quote:\n> ```\n> * 2 \"Breaking Long Lines\" striving to fit code within 80 columns and\n> accepting up to 120 columns when necessary\n> ```\n> I am not sure if this should be declared necessary.\n\nI'll update this to\n\n std::map> v4l2Formats =\n data->video_->formats();\n\n> > std::map> deviceFormats;\n> > std::transform(v4l2Formats.begin(), v4l2Formats.end(),\n> > std::inserter(deviceFormats, deviceFormats.begin()),\n> > @@ -1027,7 +1026,7 @@ Initializing device controls\n> > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n> > \n> > Pipeline handlers can optionally initialize the video devices and camera sensor\n> > -controls at system configuration time, to make sure to make sure they are\n> > +controls at system configuration time, to make sure they are\n\nAnd I'll reflow this paragraph.\n\n> > defaulted to sane values. Handling of device controls is again performed using\n> > the libcamera `controls framework`_.\n> > \n> > @@ -1240,7 +1239,7 @@ Replace the stubbed contents of ``queueRequestDevice`` with the following:\n> > << \"Attempt to queue request with invalid stream\";\n> > \n> > return -ENOENT;\n> > - }\n> > + }\n> > \n> > int ret = data->video_->queueBuffer(buffer);\n> > if (ret < 0)\n> > @@ -1396,7 +1395,7 @@ delivered to applications in the same order as they have been submitted.\n> > .. _connecting: http://libcamera.org/api-html/classlibcamera_1_1Signal.html#aa04db72d5b3091ffbb4920565aeed382\n> > \n> > Returning to the ``int VividCameraData::init()`` method, add the following above\n> > -the closing ``return 0;`` to connects the pipeline handler ``bufferReady``\n> > +the closing ``return 0;`` to connect the pipeline handler ``bufferReady``\n> > method to the V4L2 device buffer signal.\n> > \n> > .. code-block:: cpp\n> > @@ -1428,7 +1427,7 @@ code-base.\n> > Testing a pipeline handler\n> > ~~~~~~~~~~~~~~~~~~~~~~~~~~\n> > \n> > -Once you've built the pipeline handler, we ca rebuild the code base, and test\n> > +Once you've built the pipeline handler, we can rebuild the code base, and test\n> > capture through the pipeline through both of the cam and qcam utilities.\n> > \n> > .. code-block:: shell\n> > diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst\n> > index 17841ddda5f5..3e800c8e9c13 100644\n> > --- a/Documentation/sensor_driver_requirements.rst\n> > +++ b/Documentation/sensor_driver_requirements.rst\n> > @@ -34,13 +34,13 @@ For RAW sensors, the sensor driver shall support the following V4L2 controls:\n> > .. _V4L2_CID_PIXEL_RATE: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-image-process.html\n> > .. _V4L2_CID_VBLANK: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-image-source.html\n> > \n> > -While V4L2 doesn't specify a unit for the `EXPOSURE` control, libcamera requires\n> > -it to be expressed as a number of image lines. Camera sensor drivers that do not\n> > -comply with this requirement will need to be adapted or will produce incorrect\n> > -results.\n> > +While V4L2 doesn't specify a unit for the ``EXPOSURE`` control, libcamera\n> > +requires it to be expressed as a number of image lines. Camera sensor drivers\n> > +that do not comply with this requirement will need to be adapted or will produce\n> > +incorrect results.\n> > \n> > -The `HBLANK`, `PIXEL_RATE` and `VBLANK` controls are used to compute the sensor\n> > -output timings.\n> > +The ``HBLANK``, ``PIXEL_RATE`` and ``VBLANK`` controls are used to compute the\n> > +sensor output timings.\n> > \n> > Optional Requirements\n> > ---------------------\n> > diff --git a/README.rst b/README.rst\n> > index b48455ab4e67..427dbe9cd798 100644\n> > --- a/README.rst\n> > +++ b/README.rst\n> > @@ -95,9 +95,9 @@ GStreamer can find it.\n> > \n> > export GST_PLUGIN_PATH=$(pwd)/build/src/gstreamer\n> > \n> > -The debugging tool `gst-launch-1.0` can be used to construct and pipeline and test\n> > -it. The following pipeline will stream from the camera named \"Camera 1\" onto the\n> > -default video display element on your system.\n> > +The debugging tool ``gst-launch-1.0`` can be used to construct and pipeline and\n\ns/construct and pipeline/construct a pipeline/\n\nReviewed-by: Laurent Pinchart \n\n> > +test it. The following pipeline will stream from the camera named \"Camera 1\"\n> > +onto the default video display element on your system.\n> > \n> > .. code::\n> >","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 2E526BD80C\n\tfor ;\n\tThu, 18 Mar 2021 23:53:20 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 7077F68D51;\n\tFri, 19 Mar 2021 00:53:19 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 756986051D\n\tfor ;\n\tFri, 19 Mar 2021 00:53:17 +0100 (CET)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 8C2324FD;\n\tFri, 19 Mar 2021 00:53:16 +0100 (CET)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"sl4UCNZ6\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1616111597;\n\tbh=KMWDmzDY77n7c9kv3NdA6Wj4pur9yyzA1WmZNirLbYU=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=sl4UCNZ6EA4M7Tgm96vCUyGUrkPwiI3GV97UBDPPi6HD3sQIrKIlH3ma6i12x0zTE\n\tttpRZ6awONgFCXyuYsbkJW88tAYbTl2MRZ6qBOJ+wwfzlCMwb1P0ZiYGtXxtprf0TY\n\tfXemUg7ihFWxW1f6zz1tG/7O02ACC3AkImhbaV2M=","Date":"Fri, 19 Mar 2021 01:52:38 +0200","From":"Laurent Pinchart ","To":"=?utf-8?b?TsOtY29sYXMgRi4gUi4gQS4=?= Prado ","Message-ID":"","References":"<20210317192831.359014-1-nfraprado@collabora.com>\n\t<20210317192831.359014-2-nfraprado@collabora.com>\n\t<20210318050947.pwa6khb4d7hr7dzu@basti-TUXEDO-Book-XA1510>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20210318050947.pwa6khb4d7hr7dzu@basti-TUXEDO-Book-XA1510>","Subject":"Re: [libcamera-devel] [PATCH 1/5] Documentation: Fix typos and\n\twrong rST syntax for literals","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Cc":"Chris Chinchilla ,\n\tSebastian Fricke ,\n\tlibcamera-devel@lists.libcamera.org","Content-Type":"text/plain; charset=\"utf-8\"","Content-Transfer-Encoding":"base64","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]