Skip to content

Commit d5b1e8f

Browse files
committed
docs(agents): show the control search, not just require it
The prose demanded a control string and the example showed only the positive search, which makes the control read as optional advice. It is the load-bearing half: without it a broken search is indistinguishable from a stale binary, and that is not hypothetical — `strings … | grep` in Git Bash produced five confident false negatives earlier in this PR, including against the helper that does contain the change. Both commands now appear, with the repository-root path, and the fence is tagged. Outcomes measured against the two helpers the section is about rather than reasoned about: stale gives no match then HIT, current gives HIT twice.
1 parent d1f0525 commit d5b1e8f

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,14 @@ This section is the *mechanics*. **What to actually run is [`technical-documenta
9393
- **From a git worktree** (no `node_modules`/native binaries): junction/symlink `node_modules` from the main checkout (deps are usually identical — check `package-lock.json`), and copy the prebuilt native capture binaries from `electron/native/bin/<platform>/` (gitignored — rebuilding needs the full VS/Xcode toolchain). Then `npm run dev` works normally.
9494
- **Those binaries are frozen at whenever someone last built them, and nothing warns you.** They are not rebuilt by `npm run dev` or `npm run build`, so a helper older than the native change you came to test will run happily and silently exercise the old code path — the recording succeeds, and the thing you wanted to see is simply absent. Before trusting any native result, date the binary against the commit and search it for a string the change introduced — from the repo root:
9595

96-
```
96+
```powershell
97+
# the string the change introduced — absent from a stale helper
9798
findstr /M /C:"fragmented-mp4" electron\native\bin\win32-x64\wgc-capture.exe
99+
# the control — present in every helper, stale or not
100+
findstr /M /C:"encoder-selection" electron\native\bin\win32-x64\wgc-capture.exe
98101
```
99102

100-
`findstr` handles binaries and ships with Windows, whereas Git Bash has **no `strings`**, so `strings … | grep` there returns nothing and reads as a confident *absent* for every binary you point it at. Always search a control string the old binary also has (`encoder-selection`) so a broken search cannot masquerade as a stale binary. If it is stale, rebuild it with `npm run build:native:win` (or `:mac` / `:linux`) — that is the only thing that compiles a helper. Without the toolchain, test the CI-built artifact instead; a dev build cannot answer the question.
103+
Run **both**. Only the second tells "the binary is stale" apart from "my search is broken", and that distinction is not hypothetical: `findstr` handles binaries and ships with Windows, but Git Bash has **no `strings`**, so `strings … | grep` there returns nothing and reads as a confident *absent* for every binary you point it at. Measured against the two helpers this section is about — stale: no match, then HIT; current: HIT, HIT. A control that does not hit means you learned nothing about the binary. If it is stale, rebuild it with `npm run build:native:win` (or `:mac` / `:linux`) — that is the only thing that compiles a helper. Without the toolchain, test the CI-built artifact instead; a dev build cannot answer the question.
101104

102105
**Granting access**
103106

0 commit comments

Comments
 (0)