User guide: message queues and notifications
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 83/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- c
调研方向
Read the API contracts in include/emb/msgq.h and include/emb/notify.h, the behavior tests in tests/conformance/test_msgq.c and test_notify.c, and SPEC-007 and SPEC-006. Use examples/hello_app/main.c and docs/user/synchronization.md and tasks.md for examples and style. Add docs/user/communication.md, link it from docs/user/index.md, and confirm the strict docs build and every example compile.
由索引模型根据 Issue 内容生成。
描述
Goal
Write the user-guide page on message queues and notifications: docs/user/communication.md. The guide has pages on threads, synchronization and interrupts, but none yet on how threads pass data.
What exists
- The API:
include/emb/msgq.handinclude/emb/notify.h, with a contract comment on every function. - The design: SPEC-007 (message queues) and SPEC-006 (notifications).
- The tests show every behaviour:
tests/conformance/test_msgq.c,test_notify.c. - An example that uses a queue:
examples/hello_app/main.c. - The existing pages, for tone and length:
docs/user/synchronization.md,docs/user/tasks.md.
What the page should cover
- Message queues: copy by value,
EMB_MSGQ_DEFINE, send and receive with timeouts, send to the front, peek, use from an interrupt withEMB_NO_WAIT. - Direct-to-thread notifications: when to use them instead of a semaphore or a queue.
- Bindings: a semaphore, event flags or a queue notifying a thread.
- A short, complete example for each, checked by building it.
Done when
docs/user/communication.mdexists and is in the toctree ofdocs/user/index.md.- The strict docs build passes (
python tools/docs/build.py, see docs/engineering/documentation.md). - Every code example compiles; say in the PR how you checked.
- 主要语言
- C
- 星标
- 1
- 派生
- 1
- 平均合并
- 14 小时 21 分钟
- 30 天内合并 PR
- 125
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
EmbLinkOs/EmbLinkRTOS 的其他 Issue
-
enhancement good first issue help wanted
难度 2/5 1-3 小时 新手友好度 84/100
EmbLinkOs/EmbLinkRTOS#111 ·
维护者通常 1 天内回复
-
documentation good first issue help wanted
难度 3/5 1-2 天 新手友好度 76/100
EmbLinkOs/EmbLinkRTOS#116 ·
维护者通常 1 天内回复
-
good first issue
难度 4/5 3-5 天 新手友好度 55/100
EmbLinkOs/EmbLinkRTOS#115 ·
维护者通常 1 天内回复
-
documentation good first issue
难度 3/5 1-2 天 新手友好度 76/100
EmbLinkOs/EmbLinkRTOS#114 ·
维护者通常 1 天内回复
-
good first issue help wanted
难度 2/5 1-3 小时 新手友好度 34/100
EmbLinkOs/EmbLinkRTOS#112 ·
维护者通常 1 天内回复
查看 EmbLinkOs/EmbLinkRTOS 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
area: test kind: bug preview-effort: small priority: low
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
libsdl-org/SDL#16684 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
-
Issue-Bug Needs-Triage
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 2 天内回复