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
-
難度 1/5 1 小時以內 新手友好度 65/100
ly05010419/MacNativeGames#2079 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 73/100
ChupathingyCE/chupathingyce#1020 · 1 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 85/100
-
enhancement good first issue
難度 1/5 1 小時以內 新手友好度 91/100
-
C:dataplane
難度 2/5 1-3 小時 新手友好度 76/100
yanet-platform/yanet2#3395 ·
維護者通常 1 天內回覆