Skip to content

Document possible job states and their one-letter codes #206

Description

@ArthurWalraven

The man page of oarstat does not list the possible states of a job and their one-letter codes used by print_job_data to output in table format. I have witnessed multiple new users be confused with the output of, e.g., oarstat --user ... after suspecting that an F at the S column was short for Failed or something else.

One can find the relevant information at

my %hashestat = (

Otherwise, it can be difficult to find it online. So, using the definition of hashestat, I propose adding the following to the man page of oarstat (under the description of the -s,--state option):
Possible states and their associated one-character abbreviations are 'Waiting' (W), 'toLaunch' (L), 'Launching' (L), 'Hold' (H), 'Running' (R), 'Terminated' (T), 'Error' (E), 'toError' (E), 'Finishing' (F), 'Suspended' (S), 'Resuming' (S), 'toAckReservation' (W), and 'NA' (-).
Precisely, the suggestion is to append this string here:
Print only the state of a given job. It makes a minimal query to the database, optimized for scripting. Must be used with -j.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions