Skip to content

docs: stop documenting removed generator flags - #81

Merged
dlipicar merged 2 commits into
masterfrom
phase-e/drop-dead-generator-paths
Aug 19, 2026
Merged

docs: stop documenting removed generator flags#81
dlipicar merged 2 commits into
masterfrom
phase-e/drop-dead-generator-paths

Conversation

@dlipicar

Copy link
Copy Markdown
Contributor

Two documentation corrections. Both name flags or artifacts the toolchain no longer produces, so following the guide as written fails.

docs: --module-dir was removed from logos-cpp-generator — the developer guide still showed

logos-cpp-generator --metadata metadata.json --module-dir /path/to/modules --output-dir ./generated

--module-dir walked a directory of BUILT plugins and introspected them; it is gone. The replacement generates a wrapper per dependency from that dependency's LIDL contract:

logos-cpp-generator --metadata metadata.json --general-only --output-dir ./generated \
  --dep waku_module=/path/to/waku_module.lidl

docs(dev-boost): name an artifact the toolchain can still produce — same class, in the dev-boost tutorial.

Docs only; no code, no build inputs.

Part of the B3/B4 line; Set 1, with no dependency on any other open PR.

🤖 Generated with Claude Code

dlipicar and others added 2 commits August 17, 2026 09:26
The generator now refuses the flag (exit 2) instead of accepting it, so both
places the guide spelled it were about to become instructions that hard-error.
Replaced with the supported form: `--general-only` plus one
`--dep <name>=<name>.lidl` per dependency, which generates each wrapper from
that dependency's contract rather than by loading its built plugin.

Tutorial Sync Rule; the code change is in logos-cpp-sdk
(cpp-generator/legacy/main.cpp).

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The CMake block listed calc_wrap_qt_glue.h and calc_wrap_dispatch.cpp in
logos_module(SOURCES …). Those were emitted by --backend qt, which is deleted;
a module now emits <name>_cdylib_glue.{h,cpp} and Qt-plugin packaging is a
downstream step.

Nothing goes red — logos-tutorial has no dev-boost doctest — so this would have
stayed wrong silently. It was likely already stale (logos-dev-boost contains no
_qt_glue string at all), but the deletion turns "out of date" into "permanently
unbuildable", which the Tutorial Sync Rule exists to prevent.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

📊 Tutorial execution report

Rendered tutorial alongside the commands actually run and their output (updated each run, commit b67ad58):

Pages can take a minute to update after the run finishes.

@dlipicar
dlipicar merged commit d3c325e into master Aug 19, 2026
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant