From a8b31c5d98d2e06004bc35d9d0f8fc78ba016421 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Mon, 12 Oct 2020 00:12:15 +0200 Subject: [PATCH] Document some plugins --- examples/README.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/examples/README.rst b/examples/README.rst index 311b756ac2..cbc01360e2 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -953,6 +953,34 @@ Model-Related Examples .. showfile:: examples/platforms/wifi.xml :language: xml +=============== +Plugin Examples +=============== + +It is possible to extend SimGrid without modifying its internals by +attaching code to the existing signals and by adding extra data to the +simulation objects through extensions. How to do that is not exactly +documented yet, and you should look for examples in the src/plugins +directory. + +This section documents how the existing plugins can be used. Remember +that you are very welcome to modify the plugins to fit your needs. It +should be much easier than modifying the SimGrid kernel. + + - **Monitoring the host load** + + .. tabs:: + + .. example-tab:: examples/s4u/plugin-host-load/s4u-plugin-host-load.cpp + + .. example-tab:: examples/c/plugin-host-load/plugin-host-load.c + + - **Monitoring the link load** + + .. tabs:: + + .. example-tab:: examples/s4u/plugin-link-load/s4u-plugin-link-load.cpp + ======================= Model-Checking Examples ======================= -- 2.20.1