Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

flux-job(1): update WAIT section #5042

Merged
merged 1 commit into from
Mar 30, 2023
Merged

flux-job(1): update WAIT section #5042

merged 1 commit into from
Mar 30, 2023

Conversation

garlick
Copy link
Member

@garlick garlick commented Mar 29, 2023 •
edited
Loading

Problem: the man page entry for flux job wait does not adequately describe the design of waitable jobs.

Rework this section to emphasize the underlying design.

Fixes #5038

chu11
chu11 approved these changes Mar 29, 2023
View reviewed changes
Copy link
Member

@chu11 chu11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just one english error below.

doc/man1/flux-job.rst Outdated

When run with a jobid argument, ``flux job wait`` blocks until the specified
job completes. If the job was successful, it silently exits with a code of
zero. If the has failed, an error is printed on stderr, and it exits with
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the has failed -> If it has failed? If the job has failed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - fixed tthat one but realized I should also note that flux job wait currently fails for both a failed job and no more waitable jobs.

@garlick
Copy link
Member Author

garlick commented Mar 29, 2023 •
edited
Loading

Force pushed that change. The flux job wait with no arguments paragraph now reads:

When run without arguments, flux job wait blocks until the next waitable
job completes and behaves as above except that the jobid is printed to stdout.
When there are no more waitable jobs, it exits with a code of one. Note that
a while flux job wait... loop terminates on the first unsuccessful job
or when there are no more jobs.

@codecov
Copy link

codecov bot commented Mar 29, 2023

Codecov Report

Merging #5042 (417f4c1) into master (5cd101e) will decrease coverage by 0.46%.
The diff coverage is n/a.

❗ Current head 417f4c1 differs from pull request most recent head 2f1236e. Consider uploading reports for the commit 2f1236e to get more accurate results

@@            Coverage Diff             @@
##           master    #5042      +/-   ##
==========================================
- Coverage   83.59%   83.13%   -0.46%     
==========================================
  Files         441      444       +3     
  Lines       74815    76263    +1448     
==========================================
+ Hits        62544    63404     +860     
- Misses      12271    12859     +588

see 93 files with indirect coverage changes

@garlick
Copy link
Member Author

garlick commented Mar 30, 2023

Restarted the focal - py3.8 builder where the libsubprocess test_remote.t unit test had gotten stuck.

@garlick
flux-job(1): update WAIT section
ec3e98a 
Problem: the man page entry for flux job wait does not adequately
describe the design of waitable jobs.

Rework this section to emphasize the underlying design.

Fixes flux-framework#5038
@mergify mergify bot merged commit 89b5b00 into flux-framework:master Mar 30, 2023
@garlick garlick deleted the issue#5038 branch April 4, 2023 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chu11 chu11 chu11 approved these changes

Assignees
No one assigned
Labels
merge-when-passing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

flux-job(1): note that flux job wait works on jobs that specify waitable flag
2 participants
@garlick @chu11