libcamera: pipeline_handler: Update request usage comment

When a pipeline handler completes a request, the request itself is not
deleted by libcamera, and the application regains control over the
object. It may choose to delete the Request, or re-use it.

Clarify this in the comment by removing the declaration that the Request
is deleted, but state that it is no longer managed by the pipeline
handler and must not be accessed further after this function returns.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Reviewed-by: Umang Jain <email@uajain.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

1 files changed, 2 insertions, 2 deletions

diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index 84d2555f..f72d26c7 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -432,8 +432,8 @@ bool PipelineHandler::completeBuffer(Request *request, FrameBuffer *buffer)
  * \param[in] request The request that has completed
  *
  * The pipeline handler shall call this method to notify the \a camera that the
- * request has completed. The request is deleted and shall not be accessed once
- * this method returns.
+ * request has completed. The request is no longer managed by the pipeline
+ * handler and shall not be accessed once this method returns.
  *
  * This method ensures that requests will be returned to the application in
  * submission order, the pipeline handler may call it on any complete request