Skip to content

Commit

Permalink
Add documentation on OTTER_TASK_WAIT_START and OTTER_TASK_WAIT_END
Browse files Browse the repository at this point in the history
  • Loading branch information
adamtuft committed Mar 20, 2024
1 parent 7dff849 commit 2360bf5
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/pages/otter-task-graph.rst
Original file line number Diff line number Diff line change
@@ -124,6 +124,12 @@ These macros record trace events.
| | until all prior child or descendant tasks are |
| | complete. |
+--------------------------------------------+-----------------------------------------------------+
| ``OTTER_TASK_WAIT_START(task, mode)`` | Record the start of a region where the task waits |
| | for children or descendants to complete. |
+--------------------------------------------+-----------------------------------------------------+
| ``OTTER_TASK_WAIT_END(task, mode)`` | Record the end of a region where the task waits |
| | for children or descendants to complete. |
+--------------------------------------------+-----------------------------------------------------+

Managing global phases
~~~~~~~~~~~~~~~~~~~~~~

0 comments on commit 2360bf5

Please sign in to comment.