[libcamera-devel] [PATCH] Fix spelling error

[Kieran Bingham]

Hi Rishikesh,

Quoting Rishikesh Donadkar via libcamera-devel (2022-04-14 19:57:12)
> From: RISHI27-dot <rishikehsdonakdar at gmail.com>

This looks like you need to configure your git author

 git config --global author.name "Rishikesh Donadkar"

And you should add a signed-off by tag on patches you create.
I usually do that by adding a '-s' when I commit

  git commit -s -m "Documentation: Fix spelling error"

Patch titles should have a prefix (in this case 'Documentation') showing
where the commit is making changes before the brief summary.

And ideally - the commit message should say something too, in this case.

"The introduction incorrectly spells the word Compatibility. Fix it"

I know this is a trivial patch that doesn't really need much
explanation, but it's good to get in the habit for all your patches.

--
Kieran


> 
> ---
>  Documentation/guides/introduction.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst
> index 21880ce7..a4671a07 100644
> --- a/Documentation/guides/introduction.rst
> +++ b/Documentation/guides/introduction.rst
> @@ -67,7 +67,7 @@ through an adaptation layer integrating libcamera into a larger framework.
>      Adaptation Layer                                 |
>       /    +--------------+  +--------------+         |          +--------------+
>       |    |    V4L2      |  |  gstreamer   |         |          |   Android    |
> -     |    | Compatability|  |   element    |         |          |   Camera     |
> +     |    | Compatibility|  |   element    |         |          |   Camera     |

For the change itself,


Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>


You can add that to your next iteration of the patch above your
Signed-off-by: tag.



>       |    |  (preload)   |  |(libcamerasrc)|         |          |     HAL      |
>       \    +--------------+  +--------------+         |          +--------------+
>                                                       |
> -- 
> 2.25.1
>