From 8b856b5afb2bf2ca3e3d5b1f06562544f7d547f5 Mon Sep 17 00:00:00 2001 From: Hilary James Oliver Date: Mon, 11 Mar 2024 14:24:03 +1300 Subject: [PATCH] Better 'cylc message' CLI help text. --- cylc/flow/scripts/message.py | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/cylc/flow/scripts/message.py b/cylc/flow/scripts/message.py index 8e16eebe776..0727d51f387 100755 --- a/cylc/flow/scripts/message.py +++ b/cylc/flow/scripts/message.py @@ -17,16 +17,26 @@ # along with this program. If not, see . r"""cylc message [OPTIONS] -- ARGS -Record task messages. - -Send messages to: -- The job stdout/stderr. -- The job status file, if there is one. -- The scheduler, if communication is possible. - -Jobs use this command to record and report status such as success and -failure. Applications run by jobs can use this command to report messages -and to report registered task outputs. +Command to record and send messages from task jobs back to the scheduler. + +Messages are sent to: +- job stdout/stderr +- the job status file, if there is one +- the scheduler, if communication is possible + +Jobs automatically use this command to record and report job status: started +(running) and success or failure. + +Applications run by jobs can use this command to report custom messages and +and registered task output messages. + +For custom outputs, use the task message not the associated output name: +[runtime] + [[my-task]] + # ... + [[[outputs]]] + # = + x = "file x completed and archived" Messages can be specified as arguments. A '-' indicates that the command should read messages from STDIN. When reading from STDIN, multiple messages are