[libcamera-devel] libcamera: Remove outdated \todo comments

Message ID 20190426160615.22309-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit 2ab299a27686776d45699c7cea6ba9ce4af6d514
Headers show
Series
  • [libcamera-devel] libcamera: Remove outdated \todo comments
Related show

Commit Message

Laurent Pinchart April 26, 2019, 4:06 p.m. UTC
Some \todo comments are outdated and refer to tasks that have been
completed. Remove them.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/camera_manager.cpp    | 3 ---
 src/libcamera/device_enumerator.cpp | 1 -
 src/libcamera/v4l2_device.cpp       | 6 ++----
 3 files changed, 2 insertions(+), 8 deletions(-)

Comments

Kieran Bingham April 26, 2019, 4:27 p.m. UTC | #1
Nice and easy todo completions :D

On 26/04/2019 18:06, Laurent Pinchart wrote:
> Some \todo comments are outdated and refer to tasks that have been
> completed. Remove them.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> ---
>  src/libcamera/camera_manager.cpp    | 3 ---
>  src/libcamera/device_enumerator.cpp | 1 -
>  src/libcamera/v4l2_device.cpp       | 6 ++----
>  3 files changed, 2 insertions(+), 8 deletions(-)
> 
> diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
> index 58d3b0ddb8bb..40a39bd2a6d9 100644
> --- a/src/libcamera/camera_manager.cpp
> +++ b/src/libcamera/camera_manager.cpp
> @@ -50,9 +50,6 @@ LOG_DEFINE_CATEGORY(Camera)
>   * references it held to cameras, the camera manager can be stopped with
>   * stop().
>   *
> - * \todo Add ability to add and remove media devices based on hot-(un)plug
> - * events coming from the device enumerator.
> - *
>   * \todo Add interface to register a notification callback to the user to be
>   * able to inform it new cameras have been hot-plugged or cameras have been
>   * removed due to hot-unplug.
> diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp
> index f3f26d98b65e..49467546bab8 100644
> --- a/src/libcamera/device_enumerator.cpp
> +++ b/src/libcamera/device_enumerator.cpp
> @@ -40,7 +40,6 @@
>   * expressed in a DeviceMatch object.
>   *
>   * \todo Add sysfs based device enumerator.
> - * \todo Add support for hot-plug and hot-unplug.
>   */
>  
>  namespace libcamera {
> diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp
> index cfdce4813da4..a6e9ca247828 100644
> --- a/src/libcamera/v4l2_device.cpp
> +++ b/src/libcamera/v4l2_device.cpp
> @@ -750,9 +750,6 @@ int V4L2Device::releaseBuffers()
>   * processed by the device. Once the device has finished processing the buffer,
>   * it will be available for dequeue.
>   *
> - * \todo Support output devices (bytesused, ...)
> - * \todo Support imported buffers (dmabuf fd)
> - *
>   * \return 0 on success or a negative error code otherwise
>   */
>  int V4L2Device::queueBuffer(Buffer *buffer)
> @@ -904,7 +901,8 @@ int V4L2Device::streamOn()
>  /**
>   * \brief Stop the video stream
>   *
> - * \todo Ensure completion notifications are sent for all queued buffers
> + * Buffers that are still queued when the video stream is stopped are
> + * implicitly dequeued, but no bufferReady signal is emitted for them.
>   *
>   * \return 0 on success or a negative error code otherwise
>   */
>

Patch

diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
index 58d3b0ddb8bb..40a39bd2a6d9 100644
--- a/src/libcamera/camera_manager.cpp
+++ b/src/libcamera/camera_manager.cpp
@@ -50,9 +50,6 @@  LOG_DEFINE_CATEGORY(Camera)
  * references it held to cameras, the camera manager can be stopped with
  * stop().
  *
- * \todo Add ability to add and remove media devices based on hot-(un)plug
- * events coming from the device enumerator.
- *
  * \todo Add interface to register a notification callback to the user to be
  * able to inform it new cameras have been hot-plugged or cameras have been
  * removed due to hot-unplug.
diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp
index f3f26d98b65e..49467546bab8 100644
--- a/src/libcamera/device_enumerator.cpp
+++ b/src/libcamera/device_enumerator.cpp
@@ -40,7 +40,6 @@ 
  * expressed in a DeviceMatch object.
  *
  * \todo Add sysfs based device enumerator.
- * \todo Add support for hot-plug and hot-unplug.
  */
 
 namespace libcamera {
diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp
index cfdce4813da4..a6e9ca247828 100644
--- a/src/libcamera/v4l2_device.cpp
+++ b/src/libcamera/v4l2_device.cpp
@@ -750,9 +750,6 @@  int V4L2Device::releaseBuffers()
  * processed by the device. Once the device has finished processing the buffer,
  * it will be available for dequeue.
  *
- * \todo Support output devices (bytesused, ...)
- * \todo Support imported buffers (dmabuf fd)
- *
  * \return 0 on success or a negative error code otherwise
  */
 int V4L2Device::queueBuffer(Buffer *buffer)
@@ -904,7 +901,8 @@  int V4L2Device::streamOn()
 /**
  * \brief Stop the video stream
  *
- * \todo Ensure completion notifications are sent for all queued buffers
+ * Buffers that are still queued when the video stream is stopped are
+ * implicitly dequeued, but no bufferReady signal is emitted for them.
  *
  * \return 0 on success or a negative error code otherwise
  */