Documentation of os.exec*() provides confusing information about "flushing file descriptors"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
The documentation of os.exec*() says:
The current process is replaced immediately. Open file objects and descriptors are not flushed, so if there may be data buffered on these open files, you should flush them using sys.stdout.flush() or os.fsync() before calling an exec* function.
However, os.fsync() flushs OS buffers to disk, and has nothing to with flushing userspace buffer to OS.
Linked PRs
- gh-133333
Contributor guide
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
Start with the os.exec*() documentation quoted in the issue and compare the roles of sys.stdout.flush() and os.fsync(). Confirm the wording accurately distinguishes userspace buffering from OS buffers, then verify that the revised documentation clearly explains what should be flushed before exec*().
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100