User guide: software timers and work queues

Đang mở
  • Có gì không ổn?
#114 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
76/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
c
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation good first 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.
Ngôn ngữ chính
C
Star
1
Fork
1
Merge trung bình
14 giờ 21 phút
Pull request đã merge (30 ngày)
125

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của EmbLinkOs/EmbLinkRTOS

Tất cả issue của EmbLinkOs/EmbLinkRTOS

Issue tương tự

Thêm issue về C

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.