Skip to content

ROADMAP.md still claims master schedule runner uses std::stop_token; shipped code uses std::atomic<bool>& #24

Open

Description

@SoundMatt

What's wrong

ROADMAP.md:8 states the v0.1.0 checklist item as: "Master node with schedule table runner (std::stop_token)".

But the shipped implementation does not use std::stop_token anywhere:

  • include/lin/master/node.hpp:62 — std::error_code run(const std::atomic<bool>& stop)
  • src/master/node.cpp:54 — same signature

grep -r stop_token across the repo returns only the ROADMAP.md line — zero matches in actual code.

This was an intentional, documented change: commit fc1c046 ("fix: C++17 compatibility — atomic stop, shadow fix, PID test vector (#1)") switched the API from std::stop_token (a C++20 feature) to std::atomic<bool>& for C++17 compatibility, but never updated ROADMAP.md to match.

Why it matters

Minor, but the roadmap misleads readers/integrators about the actual public API shape (std::stop_token vs std::atomic<bool>& have different call-site ergonomics and semantics), and about the C++ standard version actually required (std::stop_token implies C++20, while the real requirement is C++17).

Suggested fix direction

Update ROADMAP.md:8 to read std::atomic<bool>& (or just drop the parenthetical type detail) to match the shipped API.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions