From a04b39d417a5900ff8752873f49c966c93b1a31d Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Tue, 23 Jun 2020 22:46:07 +0200
Subject: [PATCH] Update the documentation with the new runtime parameter
---
README | 3 +++
README.md | 3 +++
doc/RTD/source/CommandLineOptions/index.rst | 3 +++
3 files changed, 9 insertions(+)
diff --git a/README b/README
index 8587a13b35..6a850c5cd4 100644
--- a/README
+++ b/README
@@ -90,5 +90,8 @@ Parameters:
are dumped.
-Y, --threadpool-dumps=<int> Time-step frequency at which threadpool
tasks are dumped.
+ --dump-tasks-threshold=<flt> Fraction of the total step's time spent
+ in a task to trigger a dump of the task plot
+ on this step
See the file examples/parameter_example.yml for an example of parameter file.
diff --git a/README.md b/README.md
index 7223f4719a..bae021843e 100644
--- a/README.md
+++ b/README.md
@@ -178,5 +178,8 @@ Parameters:
are dumped.
-Y, --threadpool-dumps=<int> Time-step frequency at which threadpool
tasks are dumped.
+ --dump-tasks-threshold=<flt> Fraction of the total step's time spent
+ in a task to trigger a dump of the task plot
+ on this step
See the file examples/parameter_example.yml for an example of parameter file.
diff --git a/doc/RTD/source/CommandLineOptions/index.rst b/doc/RTD/source/CommandLineOptions/index.rst
index 2de6c6bb25..bef9953820 100644
--- a/doc/RTD/source/CommandLineOptions/index.rst
+++ b/doc/RTD/source/CommandLineOptions/index.rst
@@ -87,3 +87,6 @@ can be found by typing ``./swift -h``:
are dumped.
-Y, --threadpool-dumps=<int> Time-step frequency at which threadpool
tasks are dumped.
+ --dump-tasks-threshold=<flt> Fraction of the total step's time spent
+ in a task to trigger a dump of the task plot
+ on this step
--
GitLab