[libcamera-devel] Fixed 2 typos

15609 diff mbox series

From: KunalA18 <kunalagarwal1072002@gmail.com>

Fixed 2 typos in introduction.rst

Signed-off-by: Kunal Agarwal <kunalagarwal1072002@gmail.com>
---
 Documentation/guides/introduction.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Hello Kunal,

Thanks for the patch. There's some issue with the subject and commit
message. The subject line can be something like:

Fixed two spelling mistakes in introduction.rst

On Fri, Apr 1, 2022 at 12:29 PM Kunal Agarwal
<kunalagarwal1072002@gmail.com> wrote:
>
> From: KunalA18 <kunalagarwal1072002@gmail.com>
>

I don't think this should be a part of the patch.

> Fixed 2 typos in introduction.rst

I think this can be better written,

> Fix spelling mistakes in introduction.rst.

You can as well add "This patch has no functional changes." at the end.

>
> Signed-off-by: Kunal Agarwal <kunalagarwal1072002@gmail.com>
> ---
>  Documentation/guides/introduction.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst
> index e2091797..21880ce7 100644
> --- a/Documentation/guides/introduction.rst
> +++ b/Documentation/guides/introduction.rst
> @@ -9,7 +9,7 @@ collectively as V4L2 (`Video for Linux 2`_) and the `Media Controller`_ API
>  which provide an interface to interact and control media devices.
>
>  Included in this subsystem are drivers for camera sensors, CSI2 (Camera
> -Serial Interface) recievers, and ISPs (Image Signal Processors)
> +Serial Interface) receivers, and ISPs (Image Signal Processors)
>
>  The usage of these drivers to provide a functioning camera stack is a
>  responsibility that lies in userspace which is commonly implemented separately
> @@ -18,7 +18,7 @@ by vendors without a common architecture or API for application developers.
>  libcamera provides a complete camera stack for Linux based systems to abstract
>  functionality desired by camera application developers and process the
>  configuration of hardware and image control algorithms required to obtain
> -desireable results from the camera.
> +desirable results from the camera.
>
>  .. _Video for Linux 2: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/v4l/v4l2.html
>  .. _Media Controller: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/mediactl/media-controller.html
> --
> 2.25.1
>

Regards,
Vedant Paranjape

Hi Kunal

Thank you for the patch.

On 4/1/22 12:29, Kunal Agarwal via libcamera-devel wrote:
> From: KunalA18 <kunalagarwal1072002@gmail.com>


Is your git-author-name assigned to KunalA18? It's preferred to use your 
full-name instead, the same which appears as the sender of this mail. I 
assume the From: line should go-away then.

>
> Fixed 2 typos in introduction.rst


Usually the commit message are written as follows:

  <module/file>: <submodule, if any>: ${brief}

${description}

You can easily check the style of commit messages in the past by using:

     $> git log Documentation/guides/introduction.rst

So in this case, the commit message should look similar to one in
https://git.linuxtv.org/libcamera.git/commit/?id=030e6f3


>
> Signed-off-by: Kunal Agarwal <kunalagarwal1072002@gmail.com>


Meanwhile, the patch looks good to me but I'll hold my R-b tag for now.

> ---
>   Documentation/guides/introduction.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst
> index e2091797..21880ce7 100644
> --- a/Documentation/guides/introduction.rst
> +++ b/Documentation/guides/introduction.rst
> @@ -9,7 +9,7 @@ collectively as V4L2 (`Video for Linux 2`_) and the `Media Controller`_ API
>   which provide an interface to interact and control media devices.
>   
>   Included in this subsystem are drivers for camera sensors, CSI2 (Camera
> -Serial Interface) recievers, and ISPs (Image Signal Processors)
> +Serial Interface) receivers, and ISPs (Image Signal Processors)
>   
>   The usage of these drivers to provide a functioning camera stack is a
>   responsibility that lies in userspace which is commonly implemented separately
> @@ -18,7 +18,7 @@ by vendors without a common architecture or API for application developers.
>   libcamera provides a complete camera stack for Linux based systems to abstract
>   functionality desired by camera application developers and process the
>   configuration of hardware and image control algorithms required to obtain
> -desireable results from the camera.
> +desirable results from the camera.
>   
>   .. _Video for Linux 2: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/v4l/v4l2.html
>   .. _Media Controller: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/mediactl/media-controller.html