`fiber_cancel()` C API clarification
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_capi/fiber/
Product: Tarantool
SME: @ Gerold103
The documentation must warn that the fiber passed to
fiber_cancel() must not be already dead unless it was set to be
joinable. Same for fiber_wakeup() and all the other fiber
functions. A dead non-joinable fiber could already be freed or
reused.
Requested by @Gerold103 in https://github.com/tarantool/tarantool/commit/dbb90274217e95e3ac0a6cb68f759d6f7636202a.
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 fiber C API reference at the linked root document and review the fiber_cancel(), fiber_wakeup(), and other fiber function entries. Update the documentation to warn about dead non-joinable fibers and explain the joinable exception; the issue does not name a test or local file to run.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100