detached 72b1a28

docs(protocol): describe extension scanning without internal phase names

commit
72b1a2801c13a45eec1086a1a208b6de5e7dfa05
author
brice · · 2026-09-28 08:49 UTC
parent
edb855f
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
2 files · +3 -3
M docs/protocol-migration.md +2 -2
@@ -25,5 +25,5 @@ The scanner accepts `-import wl_surface=github.com/bnema/wlturbo/protocol/core`
2525 (repeat for each external type); local XML definitions take precedence, then
2626 explicit external mapping, then only bootstrap display/registry. Generate with
2727 `GOWORK=off go generate ./...`; metadata and XML license are in
28-`protocol/SOURCE.md`. P3 extensions will use the same scanner and public core
29-mappings; no generator-owned compositor policy is introduced here.
28+`protocol/SOURCE.md`. Extension packages under `protocol/` use the same scanner
29+and public core mappings; the generator carries no compositor policy.
@@ -25,5 +25,5 @@ The scanner accepts `-import wl_surface=github.com/bnema/wlturbo/protocol/core`
25 (repeat for each external type); local XML definitions take precedence, then25 (repeat for each external type); local XML definitions take precedence, then
26 explicit external mapping, then only bootstrap display/registry. Generate with26 explicit external mapping, then only bootstrap display/registry. Generate with
27 `GOWORK=off go generate ./...`; metadata and XML license are in27 `GOWORK=off go generate ./...`; metadata and XML license are in
28-`protocol/SOURCE.md`. P3 extensions will use the same scanner and public core28+`protocol/SOURCE.md`. Extension packages under `protocol/` use the same scanner
29-mappings; no generator-owned compositor policy is introduced here.29+and public core mappings; the generator carries no compositor policy.
M internal/scanner/scanner_test.go +1 -1
@@ -47,7 +47,7 @@ func TestCoreGeneration(t *testing.T) {
4747 }
4848 }
4949
50-// P3 uses wl_buffer as both an event-created child and a request-created child.
50+// Extension protocols use wl_buffer as both an event-created child and a request-created child.
5151 // Verify the generated code uses the public constructor instead of embedding
5252 // an inaccessible BaseProxy context field across package boundaries.
5353 func TestExternalChildFactory(t *testing.T) {
@@ -47,7 +47,7 @@ func TestCoreGeneration(t *testing.T) {
47 }47 }
48 }48 }
49 49
50-// P3 uses wl_buffer as both an event-created child and a request-created child.50+// Extension protocols use wl_buffer as both an event-created child and a request-created child.
51 // Verify the generated code uses the public constructor instead of embedding51 // Verify the generated code uses the public constructor instead of embedding
52 // an inaccessible BaseProxy context field across package boundaries.52 // an inaccessible BaseProxy context field across package boundaries.
53 func TestExternalChildFactory(t *testing.T) {53 func TestExternalChildFactory(t *testing.T) {

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 8

↑↓ moveenter openesc close