[libcamera-devel] [PATCH v2] Implementation was spelled incorrectly in the pipeline-handler documentation

[Laurent Pinchart]

On Sun, Feb 26, 2023 at 02:17:24PM +0100, Jacopo Mondi via libcamera-devel wrote:
> Hello Advait
> 
>    thanks for the patch
> 
> On Sat, Feb 25, 2023 at 07:10:45PM +0530, Advait Dhamorikar via libcamera-devel wrote:
> > Signed-off-by: Advait Dhamorikar <advaitdhamorikar at gmail.com>
> 
> A few notes about the submission process
> - The commit subject should ideally be shorter than 80 columns and
>   should report what component is modified. As an example
> 
>   documentation: guides: pipeline-handler: Fix spelling error
> 
> - We usually require a little commit message even for simple patches
>   In this case something like:
> 
>   Fix wrong spelling of "impelementation" in the pipeline handler
>   development guide.
> 
> libcamera provides git hooks in utils/hooks that help you catch these
> errors early. You can install them by copying them in your
> .git/hooks/ directory.

Note that there are both pre-commit and post-commit hooks, only one of
them is necessary. I recommend the post-commit hook, as it catches
issues in the git commit message that the pre-commit hook doesn't catch.

> > ---
> >  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.
> 
> The patch itself looks correct.
> 
> >
> >  The ``bufferReady`` function obtains the request from the buffer using the
> >  ``request`` function, and notifies the ``Camera`` that the buffer and

-- 
Regards,

Laurent Pinchart