Skip to content

Commit

Permalink
doc: clarify --since in flux-jobs(1)
Browse files Browse the repository at this point in the history
Problem: The wording in the --since option in flux-jobs(1) is a bit
misleading, suggesting that the --since option may apply only to
completed/inactive jobs.

Solution: Note that the --since option applies to jobs that were
active after the given timestamp, which makes it clear that --since
also will list pending and running jobs.
  • Loading branch information
chu11 committed May 3, 2023
1 parent 48018e8 commit 4b89d4e
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/man1/flux-jobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,11 @@ OPTIONS
Limit output to N jobs (default 1000)

**--since**\ *WHEN*
Limit output to jobs that completed or have become inactive since a
given timestamp. This option implies ``-a`` if no other ``--filter``
options are specified. If *WHEN* begins with ``-`` character, then
the remainder is considered to be a an offset in Flux standard duration
Limit output to jobs that have been active since a given timestamp. In other
words, jobs that are currently pending, currently running, or became inactive
since the given timestamp. This option implies ``-a`` if no other
``--filter`` options are specified. If *WHEN* begins with ``-`` character,
then the remainder is considered to be a an offset in Flux standard duration
(RFC 23). Otherwise, any datetime expression accepted by the Python
`parsedatetime <https://github.com/bear/parsedatetime>`_ module is
accepted. Examples: "-6h", "-1d", "yesterday", "2021-06-21 6am",
Expand Down

0 comments on commit 4b89d4e

Please sign in to comment.