Better description of status codes

diff --git a/NOTES b/NOTES
index 71d7fe92ee9d3cb649cdf368a5b1fac2ced73ce5..703001534933c078613c91d2bd86f0b3b7129939 100644 (file)
--- a/NOTES
+++ b/NOTES
@@ -40,15 +40,26 @@ Structure identical to job headers, but they do not contain a body.
 Known fields:
 
 Time: <timestamp>              UNIX timestamp of the last status change
-Status: <code>                 Machine-readable status of the job:
-                               NOPING - host does not respond to ping
-                               NOXFER - transfer of the job body to a temporary file
-                                    on the host has failed
-                               RUN - job is running (present only in log files)
-                               OK - job executed successfully (however, the job will
-                                    be removed from the queue immediately, so you are
-                                    not likely to see this code)
-                               FAILED - job failed to execute (i.e., it returned
-                                        a non-zero exit code)
-                               INTERR - internal error of BEX
+Status: <code>                 Machine-readable status of the job (see below)
 Message: <msg>                 (Optional) human-readable message explaining the status
+
+### Status codes ###
+
+NOPING         Host does not respond to ping
+NOXFER         Transfer of the job body to a temporary file on the host has failed
+OK             Job finished successfully (this is usually not seen in the queue, since
+               finished jobs are immediately deleted or moved to the history)
+FAILED         Job failed to execute (i.e., it returned a non-zero exit code)
+INTERR         Internal error of BEX (e.g., failed to read job prolog file)
+
+These are present only in log files and messages sent over status FIFO:
+
+RUN            Job is running
+SEND           Sending job to the host
+
+Status codes not tied to a specific job (sent over status FIFO):
+
+PING           Trying to ping the host
+LOCKED         Host or job not available, because it is locked by another brun
+INIT           Host ready, preparing to execute jobs
+DONE           Done with the host