[libcamera-devel,0/4] libcamera: thread: Documentation fixes and enhancements
mbox series

Message ID 20210523023155.20268-1-laurent.pinchart@ideasonboard.com
Headers show
Series
  • libcamera: thread: Documentation fixes and enhancements
Related show

Message

Laurent Pinchart May 23, 2021, 2:31 a.m. UTC 
Hello,

This patch series enhances the documentation of the Thread class and
thread usage in libcamera. Documentation issues are fixed in patches 1/4
and 3/4, with patch 2/4 adding an assertion to enforce a documented
rule. Patch 4/4 then documents race typical conditions when stopping
threads.

I'm considering further patches to handle some of the race conditions in
the Thread class itself, but until that's ready, this series brings the
documentation in sync with the implementation.

Laurent Pinchart (4):
  libcamera: thread: Document dispatchMessages() thread-safety
    requirements
  libcamera: thread: Enforce dispatchMessages() call context with assert
  libcamera: thread: Drop doc of asynchronous signals delivery to
    applications
  libcamera: thread: Document race condition at stop time

 src/libcamera/object.cpp |  8 +++++
 src/libcamera/thread.cpp | 69 ++++++++++++++++++++++++++++++++++------
 2 files changed, 68 insertions(+), 9 deletions(-)