[libcamera-devel] libcamera: media_device: Rename valid() function to isValid()
diff mbox series

Message ID 20210704234344.10765-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit fcccd7991f444332d7a0c8462ec683738c72425f
Delegated to: Laurent Pinchart
Headers show
Series
  • [libcamera-devel] libcamera: media_device: Rename valid() function to isValid()
Related show

Commit Message

Laurent Pinchart July 4, 2021, 11:43 p.m. UTC
We use isValid() instead of valid() through the code base, make
MediaDevice consistent.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 include/libcamera/internal/media_device.h | 2 +-
 src/libcamera/media_device.cpp            | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Paul Elder July 5, 2021, 3:09 a.m. UTC | #1
Hi Laurent,

On Mon, Jul 05, 2021 at 02:43:44AM +0300, Laurent Pinchart wrote:
> We use isValid() instead of valid() through the code base, make
> MediaDevice consistent.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

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

> ---
>  include/libcamera/internal/media_device.h | 2 +-
>  src/libcamera/media_device.cpp            | 6 +++---
>  2 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/include/libcamera/internal/media_device.h b/include/libcamera/internal/media_device.h
> index 8424611d7eda..3a7722c2a215 100644
> --- a/include/libcamera/internal/media_device.h
> +++ b/include/libcamera/internal/media_device.h
> @@ -35,7 +35,7 @@ public:
>  	void unlock();
>  
>  	int populate();
> -	bool valid() const { return valid_; }
> +	bool isValid() const { return valid_; }
>  
>  	const std::string driver() const { return driver_; }
>  	const std::string deviceNode() const { return deviceNode_; }
> diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp
> index e12ab1abb10d..fa50264fa253 100644
> --- a/src/libcamera/media_device.cpp
> +++ b/src/libcamera/media_device.cpp
> @@ -44,7 +44,7 @@ LOG_DEFINE_CATEGORY(MediaDevice)
>   * MediaEntity, MediaPad and MediaLink are created to model the media graph,
>   * and stored in a map indexed by object id.
>   *
> - * The graph is valid once successfully populated, as reported by the valid()
> + * The graph is valid once successfully populated, as reported by the isValid()
>   * function. It can be queried to list all entities(), or entities can be
>   * looked up by name with getEntityByName(). The graph can be traversed from
>   * entity to entity through pads and links as exposed by the corresponding
> @@ -292,7 +292,7 @@ done:
>  }
>  
>  /**
> - * \fn MediaDevice::valid()
> + * \fn MediaDevice::isValid()
>   * \brief Query whether the media graph has been populated and is valid
>   * \return true if the media graph is valid, false otherwise
>   */
> @@ -571,7 +571,7 @@ bool MediaDevice::addObject(MediaObject *object)
>   *
>   * The media device graph state is reset to invalid when the graph is cleared.
>   *
> - * \sa valid()
> + * \sa isValid()
>   */
>  void MediaDevice::clear()
>  {
> -- 
> Regards,
> 
> Laurent Pinchart
>
Umang Jain July 5, 2021, 4:44 a.m. UTC | #2
Hi Laurent,

Thank you for the patch.

On 7/5/21 5:13 AM, Laurent Pinchart wrote:
> We use isValid() instead of valid() through the code base, make
> MediaDevice consistent.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
> ---
>   include/libcamera/internal/media_device.h | 2 +-
>   src/libcamera/media_device.cpp            | 6 +++---
>   2 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/include/libcamera/internal/media_device.h b/include/libcamera/internal/media_device.h
> index 8424611d7eda..3a7722c2a215 100644
> --- a/include/libcamera/internal/media_device.h
> +++ b/include/libcamera/internal/media_device.h
> @@ -35,7 +35,7 @@ public:
>   	void unlock();
>   
>   	int populate();
> -	bool valid() const { return valid_; }
> +	bool isValid() const { return valid_; }
>   
>   	const std::string driver() const { return driver_; }
>   	const std::string deviceNode() const { return deviceNode_; }
> diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp
> index e12ab1abb10d..fa50264fa253 100644
> --- a/src/libcamera/media_device.cpp
> +++ b/src/libcamera/media_device.cpp
> @@ -44,7 +44,7 @@ LOG_DEFINE_CATEGORY(MediaDevice)
>    * MediaEntity, MediaPad and MediaLink are created to model the media graph,
>    * and stored in a map indexed by object id.
>    *
> - * The graph is valid once successfully populated, as reported by the valid()
> + * The graph is valid once successfully populated, as reported by the isValid()
>    * function. It can be queried to list all entities(), or entities can be
>    * looked up by name with getEntityByName(). The graph can be traversed from
>    * entity to entity through pads and links as exposed by the corresponding
> @@ -292,7 +292,7 @@ done:
>   }
>   
>   /**
> - * \fn MediaDevice::valid()
> + * \fn MediaDevice::isValid()
>    * \brief Query whether the media graph has been populated and is valid
>    * \return true if the media graph is valid, false otherwise
>    */
> @@ -571,7 +571,7 @@ bool MediaDevice::addObject(MediaObject *object)
>    *
>    * The media device graph state is reset to invalid when the graph is cleared.
>    *
> - * \sa valid()
> + * \sa isValid()
>    */
>   void MediaDevice::clear()
>   {

Patch
diff mbox series

diff --git a/include/libcamera/internal/media_device.h b/include/libcamera/internal/media_device.h
index 8424611d7eda..3a7722c2a215 100644
--- a/include/libcamera/internal/media_device.h
+++ b/include/libcamera/internal/media_device.h
@@ -35,7 +35,7 @@  public:
 	void unlock();
 
 	int populate();
-	bool valid() const { return valid_; }
+	bool isValid() const { return valid_; }
 
 	const std::string driver() const { return driver_; }
 	const std::string deviceNode() const { return deviceNode_; }
diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp
index e12ab1abb10d..fa50264fa253 100644
--- a/src/libcamera/media_device.cpp
+++ b/src/libcamera/media_device.cpp
@@ -44,7 +44,7 @@  LOG_DEFINE_CATEGORY(MediaDevice)
  * MediaEntity, MediaPad and MediaLink are created to model the media graph,
  * and stored in a map indexed by object id.
  *
- * The graph is valid once successfully populated, as reported by the valid()
+ * The graph is valid once successfully populated, as reported by the isValid()
  * function. It can be queried to list all entities(), or entities can be
  * looked up by name with getEntityByName(). The graph can be traversed from
  * entity to entity through pads and links as exposed by the corresponding
@@ -292,7 +292,7 @@  done:
 }
 
 /**
- * \fn MediaDevice::valid()
+ * \fn MediaDevice::isValid()
  * \brief Query whether the media graph has been populated and is valid
  * \return true if the media graph is valid, false otherwise
  */
@@ -571,7 +571,7 @@  bool MediaDevice::addObject(MediaObject *object)
  *
  * The media device graph state is reset to invalid when the graph is cleared.
  *
- * \sa valid()
+ * \sa isValid()
  */
 void MediaDevice::clear()
 {