[libcamera-devel] [PATCH v3] documentation: guides: pipeline-handler: Fix spelling error

[Kieran Bingham]

Hello Advait,

Thanks for contibuting to libcamera. Even these little patches help fix
our documentation, and help to learn the processes!

Quoting Advait Dhamorikar via libcamera-devel (2023-03-02 19:48:14)
> Please fix spelling of "impelementation" in the pipeline handler development guide.
> 

The change log should state what the patch does. Not be a request.

Please do read : https://cbea.ms/git-commit/ in full. It's a great
guide.

Your $SUBJECT line is perfect, for the message itself, try to explain
the issue, and then what or /why/ this commit does to fix it. Of course
it's not always appropriate so it seems overkill on a single spelling
patch - but it's a helpful to get into the flow and practise this for
the bigger patches too on a simple patch like this.

In this instance, something like:

"""
The pipeline handler writers guide incorrectly references the
VividCameradata::init() impelementation with a spelling error.

Fix it by correcting the typo.
"""

> ---

Now you've got this bit right. The '---' lets you add free-form comments
and discussion to the patch, which can include a message as you have
below:

> This is my first time using git send-email, thanks for the help with your replies,
> The communications and logistics documentation was quite useful for me. I'm interested in the the GSoC project that integrates libcamera into applications and am currently studying how I can interface it with libcamera.
> Do let me know if i've sent the patch correctly and also if you've any advice regarding the interfacing, that would be great too!
> 
> Signed-off-by: Advait Dhamorikar <advaitdhamorikar at gmail.com>

However, it's important that the Signed-off-by: tag goes 'above' the
first occurrance of '---'

> ---

And there shouldn't be a second '---'.


>  Documentation/guides/pipeline-handler.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst
> index e1930fdf..4d38fa23 100644
> --- a/Documentation/guides/pipeline-handler.rst
> +++ b/Documentation/guides/pipeline-handler.rst
> @@ -1409,7 +1409,7 @@ function to the V4L2 device buffer signal.
>     video_->bufferReady.connect(this, &VividCameraData::bufferReady);
>  
>  Create the matching ``VividCameraData::bufferReady`` function after your
> -VividCameradata::init() impelementation.
> +VividCameradata::init() implementation.

For the fix:


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

Please add this above your Signed-off-by: tag for a followup version.

--
Kieran

>  
>  The ``bufferReady`` function obtains the request from the buffer using the
>  ``request`` function, and notifies the ``Camera`` that the buffer and
> -- 
> 2.34.1
>