User guide: message queues and notifications
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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分
- マージ済み PR（30日）
- 125
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日以内に返信