From b5c4dc09a3fe6f8c146beb7034d5054db3a71816 Mon Sep 17 00:00:00 2001 From: Frederic Suter Date: Wed, 4 Mar 2020 13:38:25 +0100 Subject: [PATCH] update doc --- examples/README.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/examples/README.rst b/examples/README.rst index cf357fa665..3e6f6cefc5 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -119,6 +119,10 @@ Starting and Stoping Actors This demonstrates the ``start_time`` and ``kill_time`` attribute of the :ref:`pf_tag_actor` tag. + .. example-tab:: examples/c/actor-lifetime/actor-lifetime.c + + This file is not really interesting: the important matter is in the XML file. + - **Daemonize actors:** Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular actor into a daemon that will be automatically killed once the simulation is over. @@ -278,6 +282,10 @@ Communications on the Network See also :py:func:`simgrid.Mailbox.put_async()` and :py:func:`simgrid.Comm.wait()`. + .. example-tab:: examples/c/async-wait/async-wait.c + + See also :cpp:func:`sg_mailbox_put_async()` and :cpp:func:`sg_comm__wait()`. + - **Waiting for all communications in a set:** The ``wait_all()`` function is useful when you want to block until all activities in a given set have completed. @@ -288,14 +296,14 @@ Communications on the Network See also :cpp:func:`simgrid::s4u::Comm::wait_all()`. - .. example-tab:: examples/c/async-waitall/async-waitall.c - - See also :cpp:func:`sg_comm_wait_all()`. - .. example-tab:: examples/python/async-waitall/async-waitall.py See also :py:func:`simgrid.Comm.wait_all()`. + .. example-tab:: examples/c/async-waitall/async-waitall.c + + See also :cpp:func:`sg_comm_wait_all()`. + - **Waiting for the first completed communication in a set:** The ``wait_any()`` function is useful when you want to block until one activity of the set completes, no @@ -338,6 +346,11 @@ Executions on the CPU See also :py:func:`simgrid.this_actor.execute()`. + .. example-tab:: examples/c/exec-basic/exec-basic.c + + See also :cpp:func:`void sg_actor_execute(double)` + and :cpp:func:`void sg_actor_execute_with_priority(double, double)`. + - **Asynchronous execution:** You can start asynchronous executions, just like you would fire background threads. -- 2.20.1