Skip to content

Commit 8272cf5

Browse files
authored
Documentation clarifications
2 parents 0b756f4 + da50191 commit 8272cf5

File tree

2 files changed

+16
-26
lines changed

2 files changed

+16
-26
lines changed

docs/rest_api.rst

-19
Original file line numberDiff line numberDiff line change
@@ -277,25 +277,6 @@ Run the script for application "my app" using token
277277
}
278278
]
279279
280-
Container Images
281-
================
282-
283-
For development and experimentation purposes a container image exists
284-
at:
285-
286-
https://hub.docker.com/repository/docker/partio/ecflow-http
287-
288-
The image can be used for quick prototyping. It expects that ecFlow
289-
server is found from localhost:3141, change address with ECF_HOST and
290-
ECF_PORT if needed. Server does not have a SSL certificates defined, so it can only be used to query ecFlow server (not alter states etc).
291-
292-
Usage example:
293-
294-
.. code-block:: bash
295-
296-
podman run --rm -p 8080:8080 -it docker.io/partio/ecflow-http
297-
curl -kv https://localhost:8080/v1/server/ping
298-
299280
API v1 Documentation
300281
====================
301282

docs/ug/user_manual/text_based_suite_definition/dependencies/time.rst

+16-7
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ format **[h]h:mm** . Only numeric values are allowed. There can be
88
multiple time dependencies for a node, but overlapping times may cause
99
unexpected results.
1010

11+
.. note::
12+
13+
Long running Tasks might overrun the next execution slot, and when this happens the execution automatically skips
14+
to the following slot.
15+
16+
To avoid overruning execution slots, instead of a :code:`time` dependency consider specifyting a time-based trigger.
17+
See :ref:`tutorial-time-triggers` for details.
18+
19+
1120
To define a series of times, specify the start time, end time and a time
1221
increment.
1322

@@ -34,11 +43,11 @@ times you can use two separate time commands.
3443
time 15:00 # run at 15:00
3544
time 19:00 # also run at 19:00
3645
37-
.. note::
46+
.. warning::
3847

39-
You should take care with tasks using the time command to
40-
cause the suite to cycle on fast systems. If the task takes less than a
41-
minute to run then there is a possibility that the trigger will still be
42-
valid once the suite has cycled. This can be avoided by making sure that
43-
such tasks take longer than one minute to run, for example, by adding a
44-
sleep command.
48+
Beware that tasks using a :code:`time` dependency may cause the Suite to cycle on fast systems.
49+
50+
If a task takes less than a minute to run then there is a possibility that the trigger will still be
51+
valid once the suite has cycled.
52+
53+
Avoid this by ensuring that such tasks take longer than one minute to run (e.g. using the :code:`sleep` command).

0 commit comments

Comments
 (0)