User guide: software timers and work queues
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 76/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- c
調査の方向性
Start with docs/specs/SPEC-003-time-timeouts-and-timers.md and docs/specs/SPEC-006-notifications-and-work-queues.md, then check the APIs in include/emb/timer.h and include/emb/work.h and examples in examples/controller. Write docs/user/timers-and-work.md, add it to docs/user/index.md's toctree, and confirm the strict docs build passes and every example compiles; report those checks in the PR.
索引モデルが issue の本文から書いたものです。
説明
Goal
Write the user-guide page on software timers and work queues: docs/user/timers-and-work.md. Both exist and are tested, but the user guide does not explain them yet.
What exists
- The API:
include/emb/timer.h,include/emb/work.h. - The design: SPEC-003 (time, timeouts, timers) and SPEC-006 (work queues).
- The tests:
tests/conformance/test_timer.c,test_workq.c. - The reference controller uses both:
examples/controller.
What the page should cover
- One-shot and periodic timers; why a periodic timer does not drift; what happens when a callback overruns.
- Where a timer callback runs (a work queue or interrupt context), and what each allows.
- Work queues: submitting from an interrupt, cancel and synchronous cancel, flush, delayed work.
- When to use a timer, a work item or a thread with
emb_thread_sleep_until(). - A short, complete example for each.
Done when
- The page exists and is in
docs/user/index.md's toctree, and the strict docs build passes. - 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日 初心者へのやさしさ 83/100
EmbLinkOs/EmbLinkRTOS#113 ·
メンテナーはふだん 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 日以内に返信