[libcamera-devel] [PATCH 1/3] Documentation: replace ’ by '

[Jacopo Mondi]

Hi Quentin,

On Tue, May 03, 2022 at 06:30:36PM +0200, Quentin Schulz via libcamera-devel wrote:
> From: Quentin Schulz <quentin.schulz at theobroma-systems.com>
>
> 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.

You got me falling down quite a rather deep rabbit hole to find out
what character I have on my keyboard among ' (U0027) and ’ (U2019) :)

Now that I know a regular US keyboard has U0027 and I assume most
layouts have the same, then  I wonder how U2019 ended up here in first
place :)

Apart from that, seems U0027 is the 'right' choice, thanks for
spotting

Reviewed-by: Jacopo Mondi <jacopo at jmondi.org>

Thanks
  j

>
> Cc: Quentin Schulz <foss+libcamera at 0leil.net>
> Signed-off-by: Quentin Schulz <quentin.schulz at theobroma-systems.com>
> ---
>  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
> --
> 2.35.1
>