From 5d405d0ab9ad09df46a1a9432c218a61e73ffb41 Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Sat, 9 Nov 2019 09:03:31 +0100
Subject: [PATCH] Added the new runtime option to the documentation.
---
README | 4 +++-
README.md | 2 ++
doc/RTD/source/CommandLineOptions/index.rst | 2 ++
examples/main.c | 4 +++-
4 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/README b/README
index 8d722a66da..cd1be807a6 100644
--- a/README
+++ b/README
@@ -41,7 +41,9 @@ Parameters:
black holes seeding.
-x, --velociraptor Run with structure finding.
--limiter Run with time-step limiter.
-
+ --sync Run with time-step synchronization
+ of particles hit by feedback events.
+
Control options:
-a, --pin Pin runners using processor affinity.
diff --git a/README.md b/README.md
index f91b03d3f6..c4fca31879 100644
--- a/README.md
+++ b/README.md
@@ -92,6 +92,8 @@ Parameters:
perform black hole seeding.
-x, --velociraptor Run with structure finding.
--limiter Run with time-step limiter.
+ --sync Run with time-step synchronization
+ of particles hit by feedback events.
Control options:
diff --git a/doc/RTD/source/CommandLineOptions/index.rst b/doc/RTD/source/CommandLineOptions/index.rst
index 5251b36f73..353c8eafbf 100644
--- a/doc/RTD/source/CommandLineOptions/index.rst
+++ b/doc/RTD/source/CommandLineOptions/index.rst
@@ -38,6 +38,8 @@ can be found by typing ``./swift -h``:
perform black hole seeding.
-x, --velociraptor Run with structure finding.
--limiter Run with time-step limiter.
+ --sync Run with time-step synchronization
+ of particles hit by feedback events.
Control options:
diff --git a/examples/main.c b/examples/main.c
index 57a30bcd1a..21b595954e 100644
--- a/examples/main.c
+++ b/examples/main.c
@@ -222,7 +222,9 @@ int main(int argc, char *argv[]) {
"Run with structure finding.", NULL, 0, 0),
OPT_BOOLEAN(0, "limiter", &with_timestep_limiter,
"Run with time-step limiter.", NULL, 0, 0),
- OPT_BOOLEAN(0, "sync", &with_timestep_sync, "Run with time-step sync.",
+ OPT_BOOLEAN(0, "sync", &with_timestep_sync,
+ "Run with time-step synchronization of particles hit by "
+ "feedback events.",
NULL, 0, 0),
OPT_GROUP(" Control options:\n"),
--
GitLab