[libcamera-devel] libcamera: pipeline: Drop setStream() from configure() documentation

Message ID 20200928082858.2994-1-jacopo@jmondi.org
State RFC
Delegated to: Jacopo Mondi
Headers show
Series
  • [libcamera-devel] libcamera: pipeline: Drop setStream() from configure() documentation
Related show

Commit Message

Jacopo Mondi Sept. 28, 2020, 8:28 a.m. UTC
There is no requirement for Stream to be assigned to StreamConfiguration
during PipelineHandler::configure(). It actually happens at validate()
time in most implementations right now.

Drop this requirement from PipelineHandler::configure() documentation.

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
---
 src/libcamera/pipeline_handler.cpp | 4 ----
 1 file changed, 4 deletions(-)

Comments

Laurent Pinchart Sept. 28, 2020, 11:06 p.m. UTC | #1
Hi Jacopo,

Thank you for the patch.

On Mon, Sep 28, 2020 at 10:28:58AM +0200, Jacopo Mondi wrote:
> There is no requirement for Stream to be assigned to StreamConfiguration
> during PipelineHandler::configure().

There is a requirement, as it's documented :-) It doesn't mean we can't
drop the requirement if we consider it of no use.

> It actually happens at validate()
> time in most implementations right now.
> 
> Drop this requirement from PipelineHandler::configure() documentation.
> 
> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>

With the commit message reworded, including a short explanation as for
why this requirement is not needed,

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

> ---
>  src/libcamera/pipeline_handler.cpp | 4 ----
>  1 file changed, 4 deletions(-)
> 
> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
> index 918aea1e8328..713fe6d1d362 100644
> --- a/src/libcamera/pipeline_handler.cpp
> +++ b/src/libcamera/pipeline_handler.cpp
> @@ -314,10 +314,6 @@ const ControlList &PipelineHandler::properties(const Camera *camera) const
>   * perform further validation and may rely on any custom field stored in its
>   * custom CameraConfiguration derived class.
>   *
> - * When configuring the camera the pipeline handler shall associate a Stream
> - * instance to each StreamConfiguration entry in the CameraConfiguration using
> - * the StreamConfiguration::setStream() method.
> - *
>   * \context This function is called from the CameraManager thread.
>   *
>   * \return 0 on success or a negative error code otherwise

Patch

diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index 918aea1e8328..713fe6d1d362 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -314,10 +314,6 @@  const ControlList &PipelineHandler::properties(const Camera *camera) const
  * perform further validation and may rely on any custom field stored in its
  * custom CameraConfiguration derived class.
  *
- * When configuring the camera the pipeline handler shall associate a Stream
- * instance to each StreamConfiguration entry in the CameraConfiguration using
- * the StreamConfiguration::setStream() method.
- *
  * \context This function is called from the CameraManager thread.
  *
  * \return 0 on success or a negative error code otherwise