docs: stop documenting removed generator flags - #81
Merged
Conversation
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>
📊 Tutorial execution reportRendered tutorial alongside the commands actually run and their output (updated each run, commit Pages can take a minute to update after the run finishes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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--module-dirwalked a directory of BUILT plugins and introspected them; it is gone. The replacement generates a wrapper per dependency from that dependency's LIDL contract: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