-
Notifications
You must be signed in to change notification settings - Fork 43
Open
Labels
design[nature] Design issue[nature] Design issuemanual[location] Tarantool manual, no definite location[location] Tarantool manual, no definite locationserver[area] Task relates to Tarantool's server (core) functionality[area] Task relates to Tarantool's server (core) functionality
Description
Make fiber stuff well-described again
Product: Tarantool
Since:
Audience/target: Lua devs
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/fiber/
SME: @rosik
Peer reviewer: @ documentarian name
Details
Documentation about implicit cases is very poor. I believe it deserves another chapter in doc.
What information I'd like to see there:
- List ALL functions that yield explicitly. And when do they. For example, channel:get() is tricky and yields only occasionally.
- Mark ALL those functions within their sections - fio, netbox, http, socket, log (!), etc.
- Every implicit yield may raise upon wakeup if the fiber was cancelled.
- fiber.cancel doesn't yield, but still raises "fiber is cancelled" error.
- Please mention requirements for triggers too.
Definition of done
opomuc, Mons, olegrok, Totktonada, kyukhin and 1 moreKorablev77Korablev77Korablev77
Metadata
Metadata
Assignees
Labels
design[nature] Design issue[nature] Design issuemanual[location] Tarantool manual, no definite location[location] Tarantool manual, no definite locationserver[area] Task relates to Tarantool's server (core) functionality[area] Task relates to Tarantool's server (core) functionality
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
[-]Make fiber stuff well-described again[/-][+][64pt] Make fiber stuff well-described again[/+]Totktonada commentedon Sep 8, 2020
I would also create a documentation page, which describes how fibers serve requests.
Totktonada commentedon Nov 13, 2020
Related: #1648.
[-][64pt] Make fiber stuff well-described again[/-][+]Make fiber stuff well-described again[/+][-]Make fiber stuff well-described again[/-][+][13pt] Make fiber stuff well-described again[/+]artur-barsegyan commentedon Mar 10, 2021
This is another task that cannot be done with the help of documentaries. Documenters do not have the competence to determine exactly whether a yield is a function or not.
I see a simple solution:
Then transfer this information to rST.
artur-barsegyan commentedon Mar 10, 2021
And we should rename this issue into "Mark all built-in modules with information about yielding"
[-][13pt] Make fiber stuff well-described again[/-][+][13pt] Mark all built-in modules with information about yielding[/+]rosik commentedon Mar 26, 2021
Please mention requirements for triggers too.
[-][13pt] Mark all built-in modules with information about yielding[/-][+][8pt] Mark all built-in modules with information about yielding[/+]