Skip to content

Shorten compositor comments and test names - #186

Merged
DevomB merged 1 commit into
mainfrom
cleanup-compositor
Oct 7, 2026
Merged

DevomB merged 1 commit into
mainfrom
cleanup-compositor

Conversation

@DevomB

@DevomB DevomB commented Oct 2, 2026 •

Copy link
Copy Markdown
Owner

Cleanup for compositor/ (kryptik-wlproxy and zoneid) and the comments of tools/desktop/gen-wl-protocol.py.

  • Stacked comments and long doc comments become one line, or a two-line /* */ block where the reason needs it. Narration, history ("now", "yet") and rhetoric go.
  • Long test names are cut to a few words, for example shm_pool_creation_and_resize_have_byte_and_count_limits -> shm_pool_limits. No script or CI step names a test.
  • wlproxy session tests: two exact duplicate setups become with_toplevel() and with_shm(); a wire/tests.rs assertion drops a filter that always gave Some(s).
  • zoneid: error and audit messages lose their essays (nothing asserts on them); the audit's format and exit codes are unchanged.
  • Misplaced docs fixed: /// The proxied connection. sat on struct Pool.

Unchanged on purpose: the generated protocol_tables.rs and what gen-wl-protocol.py emits, and every message a test or guest check greps.

The rest of tools/desktop/ and build/desktop/dwl-config.h are left out: open pull requests #184, #188 and #191 change them. Their cleanup follows once those land.

Build cost: kryptik-wlproxy's binary changes, so the late desktop step of stage 04 rebuilds; nothing earlier.

@DevomB
DevomB force-pushed the cleanup-compositor branch 3 times, most recently from 2a88ef7 to 203b255 Compare October 2, 2026 09:09
Comment stacks in kryptik-wlproxy and zoneid become one line, or a
two-line block where the reason needs it, and long test names are cut to
a few words.

Code changes: the wlproxy session tests share two setup helpers, and
zoneid's error and audit messages lose their essays. The generated
protocol tables and zone-colours.h are unchanged.
@DevomB
DevomB force-pushed the cleanup-compositor branch from 203b255 to a1d9ad4 Compare October 2, 2026 09:09
@DevomB DevomB changed the title Shorten compositor and desktop comments and test names Shorten compositor comments and test names Oct 2, 2026
@DevomB
DevomB merged commit 023883c into main Oct 7, 2026
11 checks passed
@DevomB
DevomB deleted the cleanup-compositor branch October 7, 2026 08:17
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