[libcamera-devel,v3,22/22] libcamera: StreamConfiguration: Update stride documentation

Message ID 20200704133140.1738660-23-paul.elder@ideasonboard.com
State Superseded
Headers show
Series
  • Clean up formats in v4l2-compat and pipeline handlers
Related show

Commit Message

Paul Elder July 4, 2020, 1:31 p.m. UTC
Now that all the pipeline handlers fill in the stride information at
validation time, update the documentation accordingly.

Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>

---
New in v3
---
 src/libcamera/stream.cpp | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

Comments

Laurent Pinchart July 4, 2020, 10:03 p.m. UTC | #1
Hi Paul,

Thank you for the patch.

On Sat, Jul 04, 2020 at 10:31:40PM +0900, Paul Elder wrote:
> Now that all the pipeline handlers fill in the stride information at
> validation time, update the documentation accordingly.
> 
> Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>

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

> ---
> New in v3
> ---
>  src/libcamera/stream.cpp | 7 ++-----
>  1 file changed, 2 insertions(+), 5 deletions(-)
> 
> diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
> index 6d6e279..d5da834 100644
> --- a/src/libcamera/stream.cpp
> +++ b/src/libcamera/stream.cpp
> @@ -309,11 +309,8 @@ StreamConfiguration::StreamConfiguration(const StreamFormats &formats)
>   *
>   * The stride value reports the number of bytes between the beginning of
>   * successive lines in an image buffer for this stream. The value is
> - * valid after successfully configuring the camera with this
> - * configuration with a call to Camera::Configure().
> - *
> - * \todo Update this value when configuration is validated instead of when
> - * the camera is configured.
> + * valid after successfully validating the configuration with a call to
> + * CameraConfiguration::validate().
>   */
>  
>  /**

Patch

diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
index 6d6e279..d5da834 100644
--- a/src/libcamera/stream.cpp
+++ b/src/libcamera/stream.cpp
@@ -309,11 +309,8 @@  StreamConfiguration::StreamConfiguration(const StreamFormats &formats)
  *
  * The stride value reports the number of bytes between the beginning of
  * successive lines in an image buffer for this stream. The value is
- * valid after successfully configuring the camera with this
- * configuration with a call to Camera::Configure().
- *
- * \todo Update this value when configuration is validated instead of when
- * the camera is configured.
+ * valid after successfully validating the configuration with a call to
+ * CameraConfiguration::validate().
  */
 
 /**