[libcamera-devel,01/12] libcamera: object: Fix thread-bound reference in documentation
diff mbox series

Message ID 20240121035948.4226-2-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • libcamera: Hardening against thread race conditions
Related show

Commit Message

Laurent Pinchart Jan. 21, 2024, 3:59 a.m. UTC
The Object::message() function is documented as thread-bound without
using the correct \threadbound reference. Fix it to ensure it gets
included in the thread safety context list.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/base/object.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Milan Zamazal Jan. 22, 2024, 6:16 p.m. UTC | #1
Laurent Pinchart <laurent.pinchart@ideasonboard.com> writes:

> The Object::message() function is documented as thread-bound without
> using the correct \threadbound reference. Fix it to ensure it gets
> included in the thread safety context list.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Milan Zamazal <mzamazal@redhat.com>

> ---
>  src/libcamera/base/object.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/src/libcamera/base/object.cpp b/src/libcamera/base/object.cpp
> index 92cecd22fbe9..1fce5a2af9af 100644
> --- a/src/libcamera/base/object.cpp
> +++ b/src/libcamera/base/object.cpp
> @@ -259,7 +259,7 @@ void Object::message(Message *msg)
>   * Moving an object that has a parent is not allowed, and causes undefined
>   * behaviour.
>   *
> - * \context This function is thread-bound.
> + * \context This function is \threadbound.
>   */
>  void Object::moveToThread(Thread *thread)
>  {

Patch
diff mbox series

diff --git a/src/libcamera/base/object.cpp b/src/libcamera/base/object.cpp
index 92cecd22fbe9..1fce5a2af9af 100644
--- a/src/libcamera/base/object.cpp
+++ b/src/libcamera/base/object.cpp
@@ -259,7 +259,7 @@  void Object::message(Message *msg)
  * Moving an object that has a parent is not allowed, and causes undefined
  * behaviour.
  *
- * \context This function is thread-bound.
+ * \context This function is \threadbound.
  */
 void Object::moveToThread(Thread *thread)
 {