[2/2] guides: pipeline-handler: Update name of pipeline handler stop function

23456 diff mbox series

Since commit f6b6f15b54c2 ("libcamera: pipeline: Introduce
stopDevice()") the stop function needed to be implemented by pipeline
handlers where renamed to stopDevice().

Update the pipeline handler writers guide to match this.

Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
---
 Documentation/guides/pipeline-handler.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Hi Niklas,

Thanks for the patch.

Quoting Niklas Söderlund (2025-05-28 17:48:27)
> Since commit f6b6f15b54c2 ("libcamera: pipeline: Introduce
> stopDevice()") the stop function needed to be implemented by pipeline
> handlers where renamed to stopDevice().
> 
> Update the pipeline handler writers guide to match this.
> 
> Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
> ---
>  Documentation/guides/pipeline-handler.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst
> index fe7529759650..3adb9ce24a85 100644
> --- a/Documentation/guides/pipeline-handler.rst
> +++ b/Documentation/guides/pipeline-handler.rst
> @@ -213,7 +213,7 @@ implementations for the overridden class members.
>            std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
>  
>            int start(Camera *camera, const ControlList *controls) override;
> -          void stop(Camera *camera) override;
> +          void stopDevice(Camera *camera) override;
>  
>            int queueRequestDevice(Camera *camera, Request *request) override;
>  
> @@ -247,7 +247,7 @@ implementations for the overridden class members.
>            return -1;
>     }
>  
> -   void PipelineHandlerVivid::stop(Camera *camera)
> +   void PipelineHandlerVivid::stopDevice(Camera *camera)
>     {
>     }
>  
> @@ -1152,7 +1152,7 @@ available to the devices which have to be started and ready to produce
>  images. At the end of a capture session the ``Camera`` device needs to be
>  stopped, to gracefully clean up any allocated memory and stop the hardware
>  devices. Pipeline handlers implement two functions for these purposes, the
> -``start()`` and ``stop()`` functions.
> +``start()`` and ``stopDevice()`` functions.
>  
>  The memory initialization phase that happens at ``start()`` time serves to
>  configure video devices to be able to use memory buffers exported as dma-buf

There is one more reference to the stop function:

@@ -1261,8 +1261,8 @@ algorithms, or other devices you should also stop them.
 .. _releaseBuffers: https://libcamera.org/api-html/classlibcamera_1_1V4L2VideoDevice.html#a191619c152f764e03bc461611f3fcd35

 Of course we also need to handle the corresponding actions to stop streaming on
-a device, Add the following to the ``stop`` function, to stop the stream with
-the `streamOff`_ function and release all buffers.
+a device, Add the following to the ``stopDevice()`` function, to stop the
+stream with the `streamOff`_ function and release all buffers.

 .. _streamOff: https://libcamera.org/api-html/classlibcamera_1_1V4L2VideoDevice.html#a61998710615bdf7aa25a046c8565ed66

With that change,

Reviewed-by: Jai Luthra <jai.luthra@ideasonboard.com>

> -- 
> 2.49.0
>

Thanks,
Jai

On Fri, May 30, 2025 at 01:38:07PM +0530, Jai Luthra wrote:
> Quoting Niklas Söderlund (2025-05-28 17:48:27)
> > Since commit f6b6f15b54c2 ("libcamera: pipeline: Introduce
> > stopDevice()") the stop function needed to be implemented by pipeline
> > handlers where renamed to stopDevice().

s/where/was/

> > 
> > Update the pipeline handler writers guide to match this.
> > 
> > Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
> > ---
> >  Documentation/guides/pipeline-handler.rst | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> > 
> > diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst
> > index fe7529759650..3adb9ce24a85 100644
> > --- a/Documentation/guides/pipeline-handler.rst
> > +++ b/Documentation/guides/pipeline-handler.rst
> > @@ -213,7 +213,7 @@ implementations for the overridden class members.
> >            std::vector<std::unique_ptr<FrameBuffer>> *buffers) override;
> >  
> >            int start(Camera *camera, const ControlList *controls) override;
> > -          void stop(Camera *camera) override;
> > +          void stopDevice(Camera *camera) override;
> >  
> >            int queueRequestDevice(Camera *camera, Request *request) override;
> >  
> > @@ -247,7 +247,7 @@ implementations for the overridden class members.
> >            return -1;
> >     }
> >  
> > -   void PipelineHandlerVivid::stop(Camera *camera)
> > +   void PipelineHandlerVivid::stopDevice(Camera *camera)
> >     {
> >     }
> >  
> > @@ -1152,7 +1152,7 @@ available to the devices which have to be started and ready to produce
> >  images. At the end of a capture session the ``Camera`` device needs to be
> >  stopped, to gracefully clean up any allocated memory and stop the hardware
> >  devices. Pipeline handlers implement two functions for these purposes, the
> > -``start()`` and ``stop()`` functions.
> > +``start()`` and ``stopDevice()`` functions.
> >  
> >  The memory initialization phase that happens at ``start()`` time serves to
> >  configure video devices to be able to use memory buffers exported as dma-buf
> 
> There is one more reference to the stop function:
> 
> @@ -1261,8 +1261,8 @@ algorithms, or other devices you should also stop them.
>  .. _releaseBuffers: https://libcamera.org/api-html/classlibcamera_1_1V4L2VideoDevice.html#a191619c152f764e03bc461611f3fcd35
> 
>  Of course we also need to handle the corresponding actions to stop streaming on
> -a device, Add the following to the ``stop`` function, to stop the stream with
> -the `streamOff`_ function and release all buffers.
> +a device, Add the following to the ``stopDevice()`` function, to stop the
> +stream with the `streamOff`_ function and release all buffers.
> 
>  .. _streamOff: https://libcamera.org/api-html/classlibcamera_1_1V4L2VideoDevice.html#a61998710615bdf7aa25a046c8565ed66
> 
> With that change,
> 
> Reviewed-by: Jai Luthra <jai.luthra@ideasonboard.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

I'll add the above change when applying.