[libcamera-devel,4/5] Documentation: application-developer: Fix reference to cam BufferWriter
diff mbox series

Message ID 20210825102937.3740405-5-kieran.bingham@ideasonboard.com
State Accepted
Headers show
Series
  • application-developer: Clean up
Related show

Commit Message

Kieran Bingham Aug. 25, 2021, 10:29 a.m. UTC
The BufferWriter class has been replaced by the FileSink.

Adapt the reference, to match the source code.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 Documentation/guides/application-developer.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Laurent Pinchart Aug. 25, 2021, 7:28 p.m. UTC | #1
Hi Kieran,

Thank you for the patch.

On Wed, Aug 25, 2021 at 11:29:36AM +0100, Kieran Bingham wrote:
> The BufferWriter class has been replaced by the FileSink.
> 
> Adapt the reference, to match the source code.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

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

> ---
>  Documentation/guides/application-developer.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst
> index e2ed79d5173e..5f43af9e5a7a 100644
> --- a/Documentation/guides/application-developer.rst
> +++ b/Documentation/guides/application-developer.rst
> @@ -466,10 +466,10 @@ and the bytes used by planes.
>  A completed buffer contains of course image data which can be accessed through
>  the per-plane dma-buf file descriptor transported by the ``FrameBuffer``
>  instance. An example of how to write image data to disk is available in the
> -`BufferWriter class`_ which is a part of the ``cam`` utility application in the
> +`FileSink class`_ which is a part of the ``cam`` utility application in the
>  libcamera repository.
>  
> -.. _BufferWriter class: https://git.linuxtv.org/libcamera.git/tree/src/cam/buffer_writer.cpp
> +.. _FileSink class: https://git.linuxtv.org/libcamera.git/tree/src/cam/file_sink.cpp
>  
>  With the handling of this request completed, it is possible to re-use the
>  buffers by adding them to a new ``Request`` instance with their matching

Patch
diff mbox series

diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst
index e2ed79d5173e..5f43af9e5a7a 100644
--- a/Documentation/guides/application-developer.rst
+++ b/Documentation/guides/application-developer.rst
@@ -466,10 +466,10 @@  and the bytes used by planes.
 A completed buffer contains of course image data which can be accessed through
 the per-plane dma-buf file descriptor transported by the ``FrameBuffer``
 instance. An example of how to write image data to disk is available in the
-`BufferWriter class`_ which is a part of the ``cam`` utility application in the
+`FileSink class`_ which is a part of the ``cam`` utility application in the
 libcamera repository.
 
-.. _BufferWriter class: https://git.linuxtv.org/libcamera.git/tree/src/cam/buffer_writer.cpp
+.. _FileSink class: https://git.linuxtv.org/libcamera.git/tree/src/cam/file_sink.cpp
 
 With the handling of this request completed, it is possible to re-use the
 buffers by adding them to a new ``Request`` instance with their matching