Menu

#788 astyle-check CI break (upstream commit) + broken dev-guide User Guide link (GTK3V2MAIN)

fixed
nobody
None
2026-09-10
2026-09-10
No

Two small, unrelated issues found while triaging today's SF upstream sync (r7232->r7237) and
re-checking SF #780. Both are GTK3V2MAIN-only (the affected files/globals don't exist on
default/GTK2), so no port needed there.

  1. astyle-check CI failure: Martin Fischer's upstream commit (Hg rev 7214,
    color-globals-cleanup-gtk3, merged into GTK3V2MAIN at rev 7242) added an inline comment to
    app/bin/draw.h that pushes one line past the pinned astyle 80-column limit:

    extern wDrawColor reportIndicatorColor; / magenta -- distinct from every other default above /

Confirmed against the CI-pinned astyle 3.6.13 locally (no version drift) -- purely a
reformatting fix. This is what broke today's test/upstream-gtk3v2main-2026-09-10 CI run.

  1. Dev-guide "User Guide" nav link still broken after SF #780: str0belight's comment on #780
    (2026-09-07) reported the link gives "file couldn't be accessed" locally
    (file://.../build/docs/app/doc/html/ doesn't exist; the real path is
    build/app/doc/html/index.html) and asked that it link directly to index.html rather than a
    bare directory. #780's fix (merged 2026-09-08) replaced the hardcoded personal GitHub URL but
    left the relative path itself off by one directory level: docs/doxygen/CMakeLists.txt sets
    XTRKCAD_USERGUIDE_URL to "../../app/doc/html/", which is relative to the Doxyfile's own
    directory (build/docs/doxygen/) rather than the generated HTML page that actually uses it
    (build/docs/doxygen/html/index.html) -- landing one level short, at build/docs/app/doc/html/,
    exactly matching str0belight's report. Fix: "../../../app/doc/html/index.html".

Both will be fixed together on a single bug branch since they were found together in the same
triage pass.

Discussion

  • Allen D Byrne

    Allen D Byrne - 2026-09-10

    Both fixed and merged into GTK3V2MAIN mainline (GTK3V2MAIN-only; the affected code does not exist on default/GTK2):

    • app/bin/draw.h: comment moved above the extern declaration, now astyle-conformant (verified against CI-pinned astyle 3.6.13).
    • docs/doxygen/CMakeLists.txt: XTRKCAD_USERGUIDE_URL default corrected to "../../../app/doc/html/index.html" -- verified locally that the generated dev-guide User Guide link now resolves to a real file instead of the previous one-directory-short path. Thanks for the report, str0belight -- should be fixed now.

    git: PR #185 (github.com/adbyrne/XTrkCAD), merged after full CI green (27/27 jobs).
    Hg: bug-788-astyle-doxygen-link-fixes-gtk3, merged to GTK3V2MAIN at rev 7245, pushed to SF.

     
  • strobelight

    strobelight - 2026-09-10

    I confirmed the User Guide link now works and shows the doc instead of a directory.

     

Anonymous
Anonymous

Add attachments
Cancel