Documentation says yogrt_remaining can only be called on rank 0
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 8
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Description
The documentation says that yogrt can only be called on process 0. Presumably process means rank in an MPI context?
https://github.com/LLNL/libyogrt/blob/4346565dd36e1b847206dc35de1e65bd787a3473/doc/man/yogrt_remaining.3#L23
It also says that it will return -1 when called by any process (rank?) not equal to 0.
https://github.com/LLNL/libyogrt/blob/4346565dd36e1b847206dc35de1e65bd787a3473/doc/man/yogrt_remaining.3#L47
On lassen, it appears that `yogrt_remaining()` returns reasonable positive values when called from rank 1.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read doc/man/yogrt_remaining.3, especially the references around lines 23 and 47, then compare its rank restriction with the reported behavior of yogrt_remaining() on Lassen. Confirm the intended behavior from the issue discussion or project sources, and align the documentation with that conclusion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100