Skip to content

siblings.py and family.py: make siblings asks about the family folder before it clones, clones each member on its tracking branch, and family.py siblings runs the holder's own copy (#543) - #578

Merged
brettheap merged 8 commits into
mainfrom
fix/family-siblings-tracking-branch
Oct 15, 2026

Conversation

@brettheap

@brettheap brettheap commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Lane: openreposhape-5 (openRepoShape-5)
Claim: #543 (comment)

Three lines of #543, in one change and one re-pin, because scripts/siblings.py is a pinned copy in every family holder.

Head: 8d3d1cceb30dfc93c7ceec130131038dc4f89e40. The branch's own commits: the change (43d32eb, on bfed143), a merge of main at 9f80939 (8b4fc0b), the review round (2156a01), round 3 (5ce5b68, a family folder reached through a link; 0112dcb, a test skipped on Windows), and round 4 (8d3d1cc, a Windows junction counts as a link, and rv543b's nits).

What changed and why

1. The family folder is asked first (templates/family-root/scripts/siblings.py, _run_placement, parent_folder_warning).

  • Before: in a holder whose parent folder is not named after the family, make siblings cloned every member into that folder, then printed the warning and the mv lines, and exited 0. After the move, the re-run cloned every member a second time beside the moved holder. The first clones stayed behind.
  • Now: the check runs before any git command runs or any member is cloned. The run prints the same WARNING and mv lines, says NOTHING WAS CLONED and why, ends with siblings: stopped before cloning: the holder is not in a folder named <Family>. Nothing was cloned, fetched or moved., and exits 1 (make siblings exits 2, make's own code). --dry-run stops the same way. After the move, one run clones each member once.
  • Why a stop and not a later warning: no flag or documented answer lets a person place siblings outside the family folder. AGENTS.md, README.md, the handbook and the holder's own README and AGENTS-shape.md all describe a warning plus a printed mv, and the warning itself told the person to move the holder and re-run. A stop gives the same outcome without the stray clones. Exit 1 is the file's "finding a human can act on" (exit 2 is kept for "the question could not be asked").
  • The printed move runs as typed on every disk (review round, S3). The name test stays exact on Linux, macOS and Windows. So the remedy has to work on each:
    • On a disk that ignores case (macOS, Windows), a holder in inkrouter/ for the family InkRouter used to get mkdir -p <p>/InkRouter and mv <p>/inkrouter/InkRouter <p>/InkRouter/InkRouter. There <p>/InkRouter IS <p>/inkrouter, so that moved the holder onto itself and failed. Now, when <p>/InkRouter exists and os.path.samefile says it is this folder, the FOLDER is renamed through a staging name: mv <p>/inkrouter <p>/InkRouter.folder, then mv <p>/InkRouter.folder <p>/InkRouter.
    • At a filesystem or drive root (/InkRouter, C:\InkRouter), <root>/InkRouter is the holder itself, and the old lines were mv X X/X. Now the holder moves through <root>/InkRouter.holder, the staged move the common case already used. The warning names the root ('/') where it used to say ''.
    • Linux is unchanged: with nothing at <p>/InkRouter the holder moves there through InkRouter.holder; with a separate <p>/InkRouter folder it moves into it.
    • A link named InkRouter beside the folder and leading to it passes the check: the family folder, reached through a link (see "Round 3").
  • The header says parent folder until the check passes (C3). It used to print family folder <parent> right above a warning saying the parent is not the family folder. Through a link it names the folder the clones go into, and the link.

2. auF-13: the tracking branch (siblings.py, tracking_branch(), used in place()).

3. auF-14: the holder's pinned copy (scripts/family.py, cmd_siblings).

4. init --work-dir no longer promises clones (scripts/family.py, _print_next_steps; review round, S2). --work-dir <dir> makes no family folder. Where <dir> is not named after the family, the NEXT STEPS used to say make siblings "then puts each member's WORKING clone beside the holder, in the family folder", and family folder <dir>. That make siblings now stops. The block now says --work-dir made no family folder, so make siblings clones nothing: it prints the mv that puts the holder in a folder named <Family>, and stops until it is there, and family folder none: <dir> is not named <Family>. The --into output is byte for byte what it was.

The half of #461 that #543 names. The sibling clone is --no-local. A member url that is a path on disk is then read through git, not copied file by file, so a repack in the remote cannot break it halfway (#440).

Docs.

  • AGENTS.md family item 5 and the holder's AGENTS-shape.md said the stop "exits 1"; make siblings itself exits 2, make's own code. Both now say exit 1 (make: 2), rewrapped within the same lines. AGENTS.md stays at 490 lines.
  • The holder's README.md says the run stops before cloning, and which tracking branch it clones on.
  • templates/family-root/family.yaml's tracking_branch: comment said the family bootstrap places each member on that branch. It now says what it is: the holder's own branch, which family.py refuses to commit on. The family bootstrap leaves each member detached, and make siblings reads the member's own project.yaml. No test or pin compares those bytes.
  • README.md and docs/handbook.html are untouched (see "Left out").

The review round, point by point (rv543)

point what was found what this head does
S1 the child process lost family.py's escaped stdout (#214) env=inherited_child_environment(); test with PYTHONIOENCODING=ascii
S2 init --work-dir's NEXT STEPS promised a make siblings that stops the folder is None branch says there is no family folder; test on the fixture's own init stdout
S3 on a disk that ignores case, and at a root, the printed move cannot run the exact name test is kept on every disk; the folder rename and the staged holder move; tests by simulation on all three systems
N1 a tracking_branch: holding control characters reached stdout raw; 5 and [main] said "declares no tracking_branch" not used, shown in its repr; "is not a branch name"; three tests
N2 "before any credential is resolved" was unguarded the claim is now "before any git command runs", pinned with GIT_TRACE; reading the environment had nothing a test could observe
N3 a symlinked family folder now stops, and its printed move cannot run round 3: a link named after the family, beside the folder and leading to it, passes; see "Round 3"
N4 AGENTS.md:409 said "exits 1" for make siblings exit 1 (make: 2), within the same lines; the same fix in the holder's AGENTS-shape.md
N5 the merge section was stale rewritten below
C2 the family.yaml comment was false fixed
C3 family folder printed above a stop parent folder until the check passes

S3, the decision: keep the strict name test on every OS. Brett Heap's rule for the case variants of members/ (#362-#364, "Refuse on every disk") is one answer on every disk. The same spirit applies here. Accepting os.path.samefile(folder, wanted) instead would pass a holder on macOS that Linux stops. So every printed remedy now has to work as typed. The evidence:

  • Tests, on all three systems. The template's siblings.py is loaded in-process with load_without_bytecode, so nothing is written under templates/. Path.exists and os.path.samefile are patched to answer as a disk that ignores case does. The case-only test then does the printed moves with os.rename and checks that the next check passes. A case-sensitive disk is simulated with nothing or a separate folder at <p>/InkRouter (the separate folder skipped on Windows, see "Round 3"), and a link there, which now passes. The roots are asked as PurePosixPath("/InkRouter"), PureWindowsPath("C:\InkRouter") and PureWindowsPath("C:\inkrouter").
  • Run as typed (a throwaway probe, not committed). Each printed line went to sh -c as printed. A disk that ignores case was emulated with a symlink that spells the folder in the family's case, and that exists only while the folder does (a step that leaves it dangling removes it). Then a real siblings.py ran in the moved holder:
case lines printed run as typed then siblings.py in the moved holder
a disk that ignores case, holder in inkrouter/: 43d32eb mkdir -p <t>/InkRouter, then mv <t>/inkrouter/InkRouter <t>/InkRouter/InkRouter the mv fails, rc 1: cannot move ... to a subdirectory of itself the holder is not placed
the same, this head mv <t>/inkrouter <t>/InkRouter.folder, then mv <t>/InkRouter.folder <t>/InkRouter both rc 0 rc 0, no WARNING, IRRS and IRSS cloned beside the holder
the holder at /InkRouter: 43d32eb mkdir -p /InkRouter, then mv /InkRouter /InkRouter/InkRouter the mv fails the same way the holder is not placed
the same, this head mv /InkRouter /InkRouter.holder, mkdir -p /InkRouter, mv /InkRouter.holder /InkRouter/InkRouter all rc 0 rc 0, no WARNING, both cloned
Linux, nothing at <t>/InkRouter the three staged lines, the same on both heads all rc 0 rc 0, both cloned
Linux, a separate <t>/InkRouter folder mkdir -p and one mv, the same on both heads both rc 0 rc 0, both cloned

The filesystem root ran with / mapped to a scratch folder, because this machine has no root access and no user namespaces. C:\InkRouter and C:\inkrouter were asked of the function only. Both print WARNING the holder's parent folder is 'C:\\', not 'InkRouter'., then mv 'C:\InkRouter' 'C:\InkRouter.holder' (or 'C:\inkrouter'), mkdir -p 'C:\InkRouter' and mv 'C:\InkRouter.holder' 'C:\InkRouter\InkRouter'. Nothing here ran on a real macOS or Windows disk. CI's macOS and Windows jobs do run the case-only test's two renames on their own disks.

Tests

New file: tests/test_family_siblings_placement.py, 29 tests: 10 from the first round, 13 from the review round, 2 from round 3, 4 from round 4. The runs below are the review round's, at 2156a01; round 3's are in its own section.

All runs used a stub gh first on PATH, a bogus token, an empty GH_CONFIG_DIR, a blanked git identity, /usr/bin/python3 -m pytest:

  • tests/test_family_siblings_placement.py on the working tree, before the commit: 23 passed in 50.77s.
  • Set A at 2156a01: every tests/test_family*.py (15 files), test_park_resume_targets.py, test_windows_paths.py, test_doctor_legs_members_next.py, test_commit_trailers.py, test_free_plan_hint.py, test_refusal_default_remediation.py and test_stdout_encoding.py: 1007 passed, 20 skipped in 983.34s (0:16:23). The skips are test_family_init_values.py:219 (16) and :291 (3), which the file documents, and test_stdout_encoding.py:286 (Windows only).
  • Set B at 2156a01: test_cli_reference.py, test_repo_hygiene.py, test_agents_md_codes.py, the three test_template_* files, the four test_validate_family_*.py, the ten test_update_shape*.py of the first round, test_shape_doctor.py, and now test_update_shape_kept_helper.py (main's check of the template's imports) and test_validator_child_encoding.py (the helper S1 uses): 1478 passed, 6 skipped in 1658.89s (0:27:38). The skips are NTFS junctions (3) and the doctor's PowerShell line (3), both Windows only.
  • The merge commit 8b4fc0b on its own, before the fix: the new file, test_family.py, test_family_printed_quoting.py, test_family_makefile_siblings.py, test_park_resume_targets.py, test_windows_paths.py, test_clone_just_pushed.py and test_doctor_legs_members_next.py: 375 passed in 686.29s (0:11:26). And test_cli_reference.py, test_repo_hygiene.py, test_agents_md_codes.py, test_update_shape_kept_helper.py and test_template_text_placeholders.py: 340 passed in 245.06s (0:04:05).
  • Nothing is written under templates/: after the mutation baseline run (the new file's 23 tests, the in-process ones included, plus four more) a clean tree had no __pycache__ under templates/.

Reproduction (first round; local bare remotes, stub gh)

The script builds two scaffolded members (Atlas on main; Borealis on trunk, with its remote's default branch set to main) and a holder made with init --work-dir, so its parent folder is fam, not Orbit.

bfed143 this branch
first make siblings in fam/Orbit exit 0; Atlas and Borealis cloned into fam/; WARNING after exit 1 (make: 2); nothing cloned; NOTHING WAS CLONED
clones on disk after move + re-run 4: fam/Atlas, fam/Borealis, Orbit/Atlas, Orbit/Borealis 2: Orbit/Atlas, Orbit/Borealis
Borealis sibling branch main (remote default) trunk (its tracking branch)
family.py siblings marker from the holder's copy 0 lines (ran the standard's) 1 line
family.py siblings, holder without scripts/siblings.py exit 0, ran the standard's copy exit 2, REFUSED siblings-script-missing, the Makefile's words
make siblings, same holder exit 2, the Makefile's refusal same

The review round's reproductions are rv543's probes: PYTHONIOENCODING=ascii through family.py siblings (rc 1 with a traceback at 43d32eb; the new S1 test holds rc 0), the --work-dir NEXT STEPS, and the printed moves above.

Mutation probes

Each probe reverts one hunk in a throwaway worktree. Every one is caught.

First round (at 43d32eb; the new file plus the four changed existing tests, 15 tests):

probe what it puts back result caught by
M1 no --branch= on the clone 3 failed tracking branch, branch the remote lacks, the issue's flow
M2 no --no-local 1 failed no shared object file
M3 the warning no longer stops the run 6 failed both new misplaced tests, and the four changed existing tests
M3b the folder check back after the placement, as on main 6 failed the same six
M4 tracking_branch() never finds a branch 4 failed tracking branch, branch the remote lacks, dry-run line, the issue's flow
M5 the clone line names no branch 3 failed tracking branch, not-checked-out words, dry-run line
M6 the warning no longer says NOTHING WAS CLONED 2 failed both new misplaced tests
M7 scripts/family.py as on bfed143 2 failed holder's copy and its imports; the refusal
M8 runpy of the HOLDER's file inside family.py 1 failed holder's copy and its imports
M9 one word of the refusal differs from the Makefile's 1 failed the refusal
M10 no refusal for a holder without its copy 1 failed the refusal

Review round (at 2156a01; the new file plus the same four, 28 tests; the unmutated baseline is 28 passed):

probe what it puts back result caught by
S1 no env= on the child process 1 failed the ASCII stdout test
S2 --work-dir prints the old promise 1 failed the --work-dir NEXT STEPS test
S3a a root is not taken for the holder itself 3 failed the three root cases
S3b no rename of the folder 1 failed the case-only test
S3c a link named after the family is renamed through 1 failed (at 2156a01; equivalent since round 3) case-sensitive disk, a link
S3d same_directory asks the disk before comparing the paths 3 failed the three root cases
S3e the warning names a root '' 3 failed the three root cases
N1a a control character is used as a branch 1 failed escape-sequence
N1b 5 and [main] "declare no tracking_branch" 2 failed a-number, a-list
N2 the credential and .gitmodules read before the stop (rv543's mutation B, which nothing caught before) 1 failed the GIT_TRACE test
C3 the header always says family folder 1 failed the misplaced dry run

The doc and comment hunks have no test: AGENTS.md, the holder's AGENTS-shape.md, the family.yaml comment, the docstrings, and the tests/conftest.py comment. Round 3's mutants are in its own section.

Round 3: a family folder reached through a link (N3)

What was wrong. Take <t>/InkRouter, a link to <t>/real-x, which holds the holder. Both entry points resolve the holder to <t>/real-x/InkRouter and saw a parent named real-x. On bfed143 that was a warning, and the members were cloned into real-x. This PR turned the warning into a stop. The printed mkdir -p <t>/InkRouter passes, then mv <t>/real-x/InkRouter <t>/InkRouter/InkRouter fails with cannot move ... to a subdirectory of itself, rc 1 (rv543 had read it as working). So the PR made a dead end.

The rule (siblings.py, new family_link). Let R be the resolved holder, P its parent and G P's parent. The check also passes when G/<Family> is a link (os.path.islink) and is the same directory as P (os.path.samefile). The holder is then reachable as G/<Family>/<R.name>. The members are cloned into P, the link's own target, so the family layout holds through the link.

  • Both entry points give the same answer, because both resolve R: make siblings through find_repo_root, and family.py siblings by running the child in the resolved holder.
  • The header then reads family folder <P> (through the link G/<Family>). It names the folder the clones go into.
  • A link named after the family that leads to another folder is not accepted. Its printed move runs as typed: the holder moves into the link's target, and there the link passes.
  • A link elsewhere (~/InkRouter leading to /data/real-x) still stops. Its printed move runs as typed.
  • The case-only rename of S3 is unchanged and stays strict. On a disk that ignores case, a case-only alias is one directory entry and never a link, so it gets the rename. The two disks differ at one edge only: a link spelled in another case stops on Linux, with a staged move that runs, and passes on a disk that ignores case (round 4 corrected this sentence).

Run as typed (a throwaway probe; each printed line went to sh -c as printed, then a real siblings.py ran where the holder ended):

layout 2156a01 this head
<t>/InkRouter links to <t>/real-x, which holds the holder stops; mkdir -p <t>/InkRouter rc 0, then the mv fails, rc 1, cannot move ... to a subdirectory of itself; the next run stops again passes, rc 0, no WARNING; header family folder <t>/real-x (through the link <t>/InkRouter); IRRS and IRSS cloned into <t>/real-x
<t>/home/InkRouter links to <t>/data/real-x (a link elsewhere) stops; the three staged lines (mv <t>/data/real-x/InkRouter <t>/data/InkRouter.holder, mkdir -p <t>/data/InkRouter, mv <t>/data/InkRouter.holder <t>/data/InkRouter/InkRouter) all rc 0; the next run passes and clones both the same
<t>/InkRouter links to <t>/other; the holder is in <t>/real-x (not run) stops; mkdir -p <t>/InkRouter and mv <t>/real-x/InkRouter <t>/InkRouter/InkRouter both rc 0; the next run passes through the link, header family folder <t>/other (through the link <t>/InkRouter), both cloned into <t>/other

Tests (tests/test_family_siblings_placement.py, two new; links made with os.symlink, each test skipping first where the system refuses one; none under templates/):

  • the link layout passes through family.py siblings --dry-run and through make siblings' own script, which clones each member into the link's target;
  • a link named after the family to another folder stops, and its move done as written leads to a run that passes;
  • the case-only test still prints the two-line rename;
  • the simulated a link case of the case-sensitive disk test now patches os.path.islink too, and expects no warning.

Windows (rv543b). [a folder] of the simulated case-sensitive disk test is skipped on Windows, before any call. A WindowsPath compares without case, so same_directory() calls <p>/InkRouter and <p>/inkrouter one path there, and the case-only rename is printed. That answer is right for Windows, whose disk cannot hold the two folders, but it is not the disk the parameter simulates. Emulated on Linux with rv543b's mechanism (pathlib._is_case_sensitive returning False during each test's call): 1 failed, 24 passed in 31.32s with the parameter collected (only [a folder], since os.name is posix here), and 24 passed, 1 deselected in 31.49s without it.

Mutants (at 0112dcb, the new file, 25 tests; the baseline is 25 passed, and no __pycache__ appeared under templates/):

probe what it changes result caught by
R3a family_link never finds a link 3 failed the link layout; the link to another folder (its moved holder no longer passes); the simulated a link
R3b any same directory counts, link or not 5 failed the case-only rename (a case-only alias would pass); the three roots; the placed dry run's header
R3c any link named after the family counts, wherever it leads 1 failed the link to another folder
R3d the folder check does not ask family_link 3 failed the link layout; the link to another folder; the simulated a link
R3e the header does not name the link 1 failed the link layout

Round 2's S3c (the is_symlink test inside the case-only branch) is now an equivalent mutant: every link is answered by family_link first, so that test can no longer decide anything (25 passed with it removed). It is kept, as the S3 branch is kept as it was.

Docs. siblings.py's module docstring (FIRST, EXIT CODES) and parent_folder_warning's, and the holder's README.md and AGENTS-shape.md, say a link of the family's name beside the folder, leading to it, counts. AGENTS.md's family item 5 was left as it was in this round, on the belief that the clause needed a ninth line; rv543b showed it fits, and round 4 adds it.

Runs at 5ce5b68 (0112dcb changes only the test file; see round 4 for where 25 passed was run):

  • the new file, test_family_makefile_siblings.py, test_family_printed_quoting.py, the whole of test_family.py and test_family_tracking_branch.py: 248 passed in 196.84s (0:03:16);
  • test_template_text_placeholders.py, test_update_shape_kept_helper.py, test_cli_reference.py, test_repo_hygiene.py, test_free_plan_hint.py and test_update_shape.py: 397 passed in 213.21s (0:03:33).

Round 4 (rv543b's review of 0112dcb)

point what was found what this head does
S-1 family_link asked only os.path.islink, which is False for an NTFS directory junction, the link Windows makes without privilege. Path.resolve() follows a junction, so that layout stopped and its printed mv failed, where bfed143 warned and cloned os.path.isjunction counts too (Python 3.12 and later, False off Windows; read with getattr, so an older Python still runs the file, and there the junction case stays as it was). Not an "any alias" rule, which would make a link spelled in another case a dead end on macOS. A simulated junction test runs on every system
F2 AGENTS.md item 5 lacked the link clause the holder's README and AGENTS-shape.md have; this body said it could not fit it fits: "(nor linked as it)", rewrapped within the same eight lines by dropping one "yourself"; AGENTS.md stays at 490. README.md:883 and docs/handbook.html:1306 make the same claim and are left to a later README change (see "Left out")
F3(a) the comment and this body said the case-only rename and the link rule "never meet" corrected: a link spelled in another case (inkrouter leading to real-x) stops on Linux, with a staged move that runs, and passes as the family's link on a disk that ignores case. No dead end either way
F3(b) 0112dcb's skip reason said a Windows disk cannot hold the two folders it says the simulation assumes Windows' default path equality, which ignores case; an NTFS folder made case-sensitive can hold them
F4 three conditions no test guarded one test each: init --work-dir into a folder named after the family keeps the promise (S2c); a blank tracking_branch: " " is not a branch name (N1s); a second path to the folder under another name, neither link nor junction, is not answered by the case-only folder rename (S3f)
F5, F6 the staging names are not checked; a dangling link named after the family breaks the staged move halfway checklist candidates, below

Also corrected: round 3's 25 passed in 34.28s ran on the working tree at 5ce5b68 with 0112dcb's change not yet committed. At 0112dcb itself, the round-3 mutant baseline gave 25 passed in 32.69s.

Mutants (at 8d3d1cc, the new file, 29 tests):

probe what it changes result caught by
R4a a junction no longer counts (isjunction dropped) 1 failed, 28 passed the simulated junction
S2c init --work-dir always says there is no family folder 1 failed, 28 passed --work-dir named after the family
N1s a blank tracking_branch is used as a branch 1 failed, 28 passed [blank]
S3f the case-only folder rename for any second path to the folder 1 failed, 28 passed the rename only for a difference of case

The unmutated baseline is 29 passed, and no __pycache__ appeared under templates/ after it.

Runs at 8d3d1cc:

  • the new file on the working tree, before the commit: 29 passed in 21.84s;
  • the new file, test_family_makefile_siblings.py, test_repo_hygiene.py, test_agents_md_codes.py, and test_family.py -k "siblings or init": 195 passed, 71 deselected in 66.86s (0:01:06).

Merge

Main merged at 8b4fc0b (git merge --no-ff origin/main, main at 9f80939: #551, #552, #554, #553, #561, #562, #579, #567). One hunk conflicted, in tests/test_family_printed_quoting.py: #554 added env=NO_BYTECODE to the run_script(FAMILY, "siblings", ...) call, and this branch changed the next line from returncode == 0 to == 1. The resolution keeps both lines whole:

    result = run_script(FAMILY, "siblings", "--family-root", str(holder),
                        "--dry-run", env=NO_BYTECODE)
    assert result.returncode == 1, result.stdout + result.stderr  # #543

tests/conftest.py's comment above NO_BYTECODE said family.py siblings runs the template's copy through runpy, which this branch makes false. It now says what the constant guards and why it stays on those two calls (lane 3 agreed to the wording on #554). NO_BYTECODE stays at both call sites; dropping it is a later cleanup. The merged tree differs from main only in this branch's files and that comment.

merge-tree at 8d3d1cc: origin/main f5fc705 is clean and not merged (one more commit since dd3f23a, update-shape.py's refusal of a hard-linked file); AGENTS.md is 490 lines in the merged tree. Lane 5's fix/family-bump-to-checks (8024f9c), fix/family-members-case-variants (e5aac93), fix/family-remove-gitmodules-missing (ebe6b51) and fix/link-source-chain-defaults (a707d4b): clean. #573 and #575 were not re-checked at this head: round 4 changes siblings.py, AGENTS.md and the new test file, none of which they touch.

merge-tree at 0112dcb (git merge-tree --write-tree, after a fresh fetch):

At 2156a01, for the record:

Left out, and why

  • README.md and docs/handbook.html. README:882-884 and the handbook at :1305 say make siblings "WARNS and prints the exact mv". That stays true: the output still opens with WARNING and prints the mv. README:871-872 ("the same file through the other entry point") becomes true with this change. Neither says the run now stops; that is incomplete, not false, so this PR does not touch README.md. Adding "and clones nothing until it is moved" could be a later README change. That change should also add the link clause round 3 gave the holder's README and AGENTS-shape.md and round 4 gave AGENTS.md: README.md:883 and the handbook at :1306 say the run warns whenever the parent folder is not named after the family, which a family folder reached through a link no longer does. They are left alone here because a README change needs the hash step and README PRs land one at a time.
  • scripts/shape_materialize.py:519: its comment says siblings "warns about the parent folder without moving anything", which is still true. It is left alone because PRs that touch that file meet SonarCloud's S8705 finding at run().
  • templates/family-root/scripts/validate-family.py: not touched (lane 2's Pinned validators: THE LOCKSTEP RULE only where it applies, and remedies that name the git switch -c step (one shape bump) #539).
  • The --make dispatch header still prints family folder. The dispatch runs no folder check (it is the placement's business), so it was left as it is.

Checklist candidates

  • make siblings crashes on a stdout that cannot encode its em dash or a path. Pre-existing on bfed143. The holder's siblings.py never escapes its own stdout, so under PYTHONIOENCODING=ascii, or a Windows code page without a character in the holder path or a member name, make siblings dies with a UnicodeEncodeError on its first line, before any clone. family.py siblings no longer does (S1), because it hands the child its own escaped settings. The family bootstrap.py already calls repo_shape.escape_unencodable_stdout(); a holder that kept an older repo_shape.py may not have it, which main's kept-helper check now looks at.
  • shape-doctor.py:5640: the members row's note says "make siblings places them", a command that now stops, clones nothing, in a holder whose parent folder is not named after the family.
  • A family name a disk cannot hold exactly never passes the folder test on that disk. Windows drops a trailing . or space from a folder name and reserves names like CON and NUL. --family goes through SAFE_ARG_RE (scripts/repo_shape.py:106), which allows a trailing .. Such a holder stops on every run there.
  • A tracking_branch: that names only a tag gives a detached clone. git clone --branch=<name> takes a tag too, so a member that declares v1 where its remote has only a tag v1 is cloned detached at the tag, rc 0, and the line calls it "its tracking branch".
  • tests/test_cli_reference.py writes templates/family-root/scripts/__pycache__/bootstrap.cpython-312.pyc (found by rv441b on validate-repository-naming.py, repo_shape.py, validate-pins.py: a bare --link-source is the first chain link's tree alone, and a source that names no path is refused (#441, #442) #576 and here). scripts/render-cli-reference.py runs the template's siblings.py --help with PYTHONPATH=scripts, and that file imports bootstrap from beside it. Shown in clean trees: no __pycache__ before, the file after tests/test_cli_reference.py alone (22 passed), on 04c9d77, on two merged trees, and on this branch's merge. .gitignore hides it. A .pyc under templates/ breaks template_values() and its twin in test_scaffold_leg_path_collisions.py in a later run in the same tree, which read every template file as UTF-8. tests: every test that clones a just-pushed local remote by its plain path now clones it with clone_just_pushed, so the macOS failed to copy file race of #440 cannot reach it; load_without_bytecode keeps the doctor's and the Windows-path tests' loads of the family root's scripts from writing .pyc into the templates; the not-a-list doctor cases hold INVALID, exit 1; and GOOD_KEYS holds th #554's load_without_bytecode does not cover it; PYTHONDONTWRITEBYTECODE=1 in the renderer's child environment would.
  • A staging name that already exists sends the moves astray (F5). Neither <Family>.folder (round 2) nor the older <Family>.holder is checked before it is printed. With <t>/InkRouter.folder already a folder, on an emulated disk that ignores case, both printed lines exit 0 and leave the holder at InkRouter/inkrouter/InkRouter (rv543b's probe). The next run stops again with a rename that works, so it is recoverable. The move text predates this PR; the stop is what makes it the only way forward.
  • A dangling link named after the family breaks the staged move halfway (F6). not wanted.exists() follows the link, so a dangling <t>/InkRouter reads as nothing there: mv <t>/real-x/InkRouter <t>/InkRouter.holder exits 0, then mkdir -p <t>/InkRouter fails, File exists, and the holder is left at <t>/InkRouter.holder (rv543b's probe). os.path.lexists would send it to the two-line move, whose mkdir -p fails before anything moves. The move text predates this PR; the stop is what makes it the only way forward.
  • tests/test_validator_child_encoding.py's launcher guard does not see family.py. It looks for subprocess.run([sys.executable, ...]), and family.py runs [sys.executable or PYTHON, ...], so the guard would not notice if env= were dropped again. The new S1 test catches that by behaviour (probe S1), but the static guard could list family.py too.

Closes #543

🤖 Generated with Claude Code

Summary by Sourcery

Make sibling placement safe and consistent by validating the family layout before cloning, selecting each member’s tracking branch, and running the holder’s pinned utility.

New Features:

  • Make sibling placement validate the holder’s family-folder layout before cloning and support family folders reached through links or junctions.
  • Clone new siblings on each member’s declared tracking branch when available, while safely falling back to the remote default branch for missing or invalid declarations.
  • Run family.py siblings using the holder’s pinned sibling utility and reject holders missing that script.

Bug Fixes:

  • Prevent misplaced-holder runs from creating stray clones that would be duplicated after relocation.
  • Ensure printed relocation commands work for case-insensitive filesystems and filesystem or drive roots.
  • Preserve escaped stdout behavior when the holder utility runs as a child process.
  • Correct init --work-dir guidance so it no longer promises clones when no valid family folder exists.

Enhancements:

  • Use non-local cloning to avoid sharing object files with path-based remotes.
  • Expand sibling placement diagnostics for invalid tracking-branch values and link-based layouts.

Documentation:

  • Update family guidance, generated holder documentation, and configuration comments to describe pre-clone validation, tracking branches, link-based layouts, and exit codes.

Tests:

  • Add comprehensive coverage for placement validation, tracking-branch selection, safe relocation commands, link and junction handling, child-process behavior, and holder-script execution.

…er before it clones anything, clones each member on the tracking branch its pinned `project.yaml` declares, and `family.py siblings` runs the holder's own copy, so a misplaced holder no longer gets every member cloned twice, a member no longer lands on its remote's default branch, and the two entry points no longer run different code (#543)

`templates/family-root/scripts/siblings.py` (the copy every holder pins):
- The parent-folder check runs FIRST. A holder whose parent folder is not
  named after the family now stops before any credential is resolved or any
  member cloned: the WARNING says nothing was cloned and why, prints the same
  `mv` lines, and the run exits 1 ("siblings: stopped before cloning ...
  Nothing was cloned, fetched or moved."). `--dry-run` stops the same way.
  It used to clone every member into the wrong folder, then warn, so the
  re-run after the move cloned each member a second time.
- A new sibling is cloned with `--branch=<tracking branch>`, the
  `tracking_branch:` of the member's own `project.yaml` in the pinned copy
  under `members/`. A plain clone took the remote's default branch. With no
  pinned copy checked out, or no `tracking_branch:` there, the clone keeps
  the default branch as before and its line says why. `.gitmodules` carries
  no `branch=` and `family.yaml`'s `tracking_branch:` is the holder's own, so
  neither is read. A declared branch the remote lacks is git's refusal, a
  CLONE FAILED finding, exit 1.
- The clone is `--no-local`: a member url that is a path on disk is read
  through git and not copied file by file, which a repack in the remote can
  break (#440; the half of #461's line #543 names).

`scripts/family.py`: `siblings` runs `<holder>/scripts/siblings.py` with this
interpreter, in its own process, from the holder, as `make siblings` does,
and returns its exit code. Every word of that command is a constant
(`scripts/siblings.py --root .`, run in the holder), so no value from the
command line reaches its argv. It used to `runpy` the standard's template copy
inside this process, where that file imported this checkout's `repo_shape`.
A holder without the file is refused, `siblings-script-missing`, exit 2, in
the words the holder's Makefile refuses with (#503). `runpy` is no longer
imported.

Docs: AGENTS.md (family item 5, same line count), the holder's README.md and
AGENTS-shape.md say the run stops before cloning; the README names the
tracking branch it clones on. Tests: tests/test_family_siblings_placement.py
(new); three existing tests that held exit 0 for a misplaced holder now hold
exit 1, one test docstring that named `runpy` is corrected, and
tests/test_family_makefile_siblings.py's `cut()` puts its holder copies in
a folder named after the family, where `make siblings` runs to the end.

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@brettheap

Copy link
Copy Markdown
Contributor Author

(lane openRepoShape-5, 2026-10-14T23:37Z) @codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@sourcery-ai

sourcery-ai Bot commented Oct 14, 2026

Copy link
Copy Markdown

Reviewer's Guide

The PR updates sibling placement to validate the holder's folder before any side effects, clones new members on their pinned tracking branches with --no-local isolation, and makes family.py siblings run the holder's own pinned script in a subprocess; documentation and regression tests are updated for the new contracts.

Sequence diagram for sibling placement validation and cloning

sequenceDiagram
    participant User
    participant Siblings as siblings.py
    participant Git as git
    participant Member as members/Project/project.yaml

    User->>Siblings: main(--root, --dry-run?)
    Siblings->>Siblings: parent_folder_warning(root, family)
    alt parent folder is not named after family
        Siblings-->>User: WARNING, mv command, NOTHING WAS CLONED
        Siblings-->>User: exit 1
    else valid family folder
        Siblings->>Member: tracking_branch(root, row)
        alt tracking branch declared
            Member-->>Siblings: branch, project.yaml path
            Siblings->>Git: clone --no-local --branch=branch
        else branch unavailable locally
            Member-->>Siblings: default-branch reason
            Siblings->>Git: clone --no-local
        end
        Git-->>Siblings: clone result
        Siblings-->>User: placement result and exit code
    end
Loading

Sequence diagram for family.py siblings using the holder copy

sequenceDiagram
    participant User
    participant Family as family.py
    participant Holder as Holder
    participant Script as Holder/scripts/siblings.py

    User->>Family: cmd_siblings(--family-root, --dry-run?)
    Family->>Holder: check scripts/siblings.py
    alt script missing
        Family-->>User: Refusal siblings-script-missing
        Family-->>User: exit 2
    else script exists
        Family->>Script: subprocess.run(scripts/siblings.py, --root ., cwd=holder)
        Script-->>Family: exit code
        Family-->>User: return unchanged exit code
    end
Loading

Flow diagram for safe sibling placement

flowchart TD
    A[Start make siblings] --> B[Check holder parent folder]
    B -->|Not named after family| C[Print WARNING and mv command]
    C --> D[Print NOTHING WAS CLONED]
    D --> E[Exit 1]
    B -->|Named after family| F[Resolve credentials and member URLs]
    F --> G[Read member tracking_branch]
    G --> H[Clone with --no-local and --branch when known]
    H --> I[Run member bootstrap]
    I --> J[Report placement result]
Loading

File-Level Changes

Change Details Files
Prevent misplaced-holder runs from performing any placement work before the holder is moved into a correctly named family folder.
  • Run the parent-folder validation before credential resolution, URL discovery, cloning, or fetching, including for dry runs.
  • Emit the existing warning and move commands with explicit no-clone messaging, then return exit code 1.
  • Update the placement contract and documentation to describe the stop-before-cloning behavior.
templates/family-root/scripts/siblings.py
AGENTS.md
templates/family-root/AGENTS-shape.md
templates/family-root/README.md
tests/test_family.py
tests/test_family_printed_quoting.py
tests/test_family_makefile_siblings.py
tests/test_family_siblings_placement.py
Clone absent siblings on each member's declared tracking branch while preserving a documented default-branch fallback and preventing local-object sharing.
  • Read tracking_branch from the pinned member project.yaml and pass it to git clone when available.
  • Report the source of the branch decision and fall back to the remote default branch when the pinned manifest is unavailable or lacks a branch.
  • Use --no-local for path-based remotes and report missing remote branches as clone findings without leaving partial directories.
templates/family-root/scripts/siblings.py
templates/family-root/README.md
tests/test_family_siblings_placement.py
Make family.py siblings execute the holder's pinned utility copy as a separate subprocess, matching the Makefile entry point and preserving its exit status.
  • Replace runpy execution of the standard template with the holder-relative scripts/siblings.py.
  • Run with the holder as cwd, --root ., the selected interpreter, and optional --dry-run; return the subprocess status unchanged.
  • Refuse holders missing their pinned siblings script with exit 2 and Makefile-compatible remediation text.
scripts/family.py
tests/test_family.py
tests/test_family_siblings_placement.py
Expand regression coverage for folder placement, branch selection, clone isolation, and holder-copy dispatch.
  • Add tests for tracking/upstream branches, fallback wording, nonexistent branches, dry-run output, and --no-local inode separation.
  • Test the misplaced-holder stop and move-then-clone-once workflow, including dry runs.
  • Test holder-specific imports and exact refusal behavior when the pinned script is absent.
tests/test_family_siblings_placement.py
tests/test_family.py
tests/test_family_printed_quoting.py
tests/test_family_makefile_siblings.py

Assessment against linked issues

Issue Objective Addressed Explanation
#543 Check whether the holder is in a folder named after the family before cloning or fetching members; if not, warn, print the move instructions, and stop so moving the holder and rerunning does not leave duplicate clones. ✅
#543 Clone each new member on the tracking branch declared by its pinned project configuration, explain the default-branch fallback when that declaration is unavailable, and avoid unsafe local-path clone behavior. ✅
#543 Make family.py siblings run the holder’s pinned scripts/siblings.py copy, refusing clearly when that file is missing. ✅

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Brett Heap and others added 2 commits October 15, 2026 11:27
… tests/test_family_printed_quoting.py keeps #554's `env=NO_BYTECODE` call line and this branch's exit-1 assert, and tests/conftest.py's `NO_BYTECODE` comment no longer says `family.py siblings` runs the template's copy through `runpy` (#543)

Main moved from bfed143 to 9f80939: #551, #552, #554, #553, #561, #562,
#579 and #567. One hunk conflicted.

tests/test_family_printed_quoting.py, in
test_the_siblings_mv_lines_paste_whole_and_move_the_holder: #554 (2247dbf)
added `env=NO_BYTECODE` to the `run_script(FAMILY, "siblings", ...)` call,
and this branch changed the next line's `returncode == 0` to `== 1`, because
a misplaced holder now stops before cloning. The two lines are adjacent.
Resolved to #554's call line and this branch's assert, both kept whole:

    result = run_script(FAMILY, "siblings", "--family-root", str(holder),
                        "--dry-run", env=NO_BYTECODE)
    assert result.returncode == 1, result.stdout + result.stderr  # #543

tests/test_family.py merged by itself: its `env={**ALLOW_FILE_PROTOCOL,
**NO_BYTECODE}` call sits under this branch's corrected docstring.

tests/conftest.py: #554's comment above `NO_BYTECODE` said `family.py
siblings` runs the standard's `templates/family-root/scripts/siblings.py`
through `runpy`. On this branch it runs the holder's own copy in a child
process standing in the holder, so that sentence became false in this merge.
The comment now says what the constant is for, what it used to guard, and
why it stays on those two calls. Lane 3 agreed to this wording on #554.
`NO_BYTECODE` stays at both call sites; removing it is a later cleanup.

The merged tree differs from 9f80939 only in this branch's nine files and
that comment.

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…hat ignores case and at a filesystem or drive root, `family.py siblings` keeps family.py's escaped stdout in the child it runs, `init --work-dir` no longer promises a `make siblings` that stops, and a `tracking_branch:` that is no branch name is shown escaped and not used, so a stopped holder is never left with a remedy that cannot run (#543)

The review round of #543 (rv543: S1-S3, N1-N5, C2, C3).

`templates/family-root/scripts/siblings.py` (the copy every holder pins):
- S3. The parent-folder name test stays exact on every disk, so the
  printed move now runs as typed on every disk. When `<parent>/<Family>`
  is this folder under another case (a disk that ignores case, found with
  `os.path.samefile`), the FOLDER is renamed through `<Family>.folder`,
  two `mv` lines: the old `mkdir -p` + `mv` moved the holder onto itself
  and failed. When the parent is a filesystem or drive root, so that
  `<root>/<Family>` is the holder itself, the holder moves through
  `<Family>.holder`, the staged move the common case already used; the
  old lines were `mv X X/X`. A case-sensitive disk is unchanged, and a
  link named `<Family>` onto the folder is never renamed through. The
  new `same_directory` asks equal paths first, so a drive root can be
  asked of a `PureWindowsPath`. The warning names a root as `'/'` rather
  than `''`.
- N1. A `tracking_branch:` that is not a branch name is not used: a
  number or a list says so, and a string holding a character that does
  not print (an ESC sequence, a newline) is shown in its `repr`, never raw.
  The clone keeps the remote's default branch, as for no declaration. No
  import was added.
- C3. The placement header says `parent folder` until the folder check
  passes, and `family folder` after.
- N2. The `_run_placement` docstring now says the stop comes before any
  `git` command runs, which a test pins; "before any credential is
  resolved" was an environment read nothing could observe.

`scripts/family.py`:
- S1. `siblings` gives its child `inherited_child_environment()`, as
  `update-shape.py` does for the validators it runs (#254): this stdout's
  own encoding and a handler that cannot raise. The child process had its
  own strict stdout, so `PYTHONIOENCODING=ascii` (or a Windows code page
  without a character in a path) ended it with a UnicodeEncodeError on
  its first line, where the in-process run had escaped it (#214). The
  helper already guards a stdout with no encoding and a handler only this
  process registered.
- S2. `init --work-dir <dir>` makes no family folder, and `make siblings`
  stops before cloning in a holder whose parent is not named after the
  family. Where `<dir>` is not so named, the NEXT STEPS now say there is no
  family folder and that `make siblings` clones nothing until the holder
  sits in a folder named `<Family>`, instead of promising clones there.
  The `--into` output is byte for byte what it was.

Docs:
- N4. AGENTS.md family item 5 and the holder's AGENTS-shape.md said the
  stop "exits 1"; `make siblings` itself exits 2, make's own code. Both
  now say `exit 1 (`make`: 2)`, rewrapped within the same lines (AGENTS.md
  stays at 490).
- C2. `templates/family-root/family.yaml`'s `tracking_branch:` comment said
  the family bootstrap places each member on that branch. It is the
  holder's own branch, which `family.py` refuses to commit on; the
  bootstrap leaves each member detached, and `make siblings` reads the
  member's own `project.yaml`. No test or pin compares those bytes.

Tests, all in tests/test_family_siblings_placement.py (13 new): the ASCII
stdout through `family.py siblings`; the `--work-dir` NEXT STEPS; the
case-only rename (with `Path.exists` and `os.path.samefile` answering as
a disk that ignores case, then the moves done as written); a
case-sensitive disk with nothing, a folder or a link at `<Family>`; `/`,
`C:\` and `C:\` in another case as pure paths; three `tracking_branch`
values; `GIT_TRACE` showing no `git` ran before the stop; and the header
in two existing tests. The template script is loaded in-process with
`load_without_bytecode`, so nothing is written under `templates/`.

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Brett Heap and others added 2 commits October 15, 2026 12:32
…t folder and leading to it, passes the folder check, so a holder in a symlinked family folder is no longer stopped with a printed move that cannot run (#543)

The review round's N3, which round 3 found worse than first read: with
`<t>/InkRouter` a link to `<t>/real-x`, which holds the holder, both entry
points resolve the holder to `<t>/real-x/InkRouter` and stopped, and the
printed `mkdir -p <t>/InkRouter` then `mv <t>/real-x/InkRouter
<t>/InkRouter/InkRouter` fails with `cannot move ... to a subdirectory of
itself`. This PR made that warning a stop, so it made the dead end.

`templates/family-root/scripts/siblings.py`:
- New `family_link(root, family)`: with R the resolved holder, P its parent
  and G P's parent, `G/<Family>` when `os.path.islink` says it is a link and
  `same_directory` (`os.path.samefile`) says it is P. `parent_folder_warning`
  passes on it. The holder is then reachable as `G/<Family>/<R.name>`, and
  the members are cloned into P, the link's own target, so the layout holds
  through the link. `make siblings` (through `find_repo_root`) and
  `family.py siblings` (the child stands in the resolved holder) give the
  same answer.
- A link named after the family that leads anywhere else is not accepted:
  the run stops and its printed move runs as typed, putting the holder
  into the link's target, where the next run passes. A link elsewhere in
  the tree (`~/InkRouter` to `/data/real-x`) stops too, and its staged move
  runs as typed.
- The header says `family folder <P>   (through the link G/<Family>)` when
  the check passes through a link, so it names the folder the clones go
  into.
- The case-only rename of the review round is unchanged and stays strict.
  A comment says why the two rules never meet: on a disk that ignores case,
  a case-only alias is one directory entry, never a link.
- The module docstring (FIRST, EXIT CODES) and `parent_folder_warning`'s
  say so; so do the holder's README.md and AGENTS-shape.md. AGENTS.md's
  family item 5 is unchanged: its eight-line paragraph cannot take the
  clause without a ninth line, and the file is at its 490-line cap.

tests/test_family_siblings_placement.py: the link layout passes through
both entry points and `make siblings`' script clones beside the holder,
into the link's target; a link named after the family to another folder
stops, and its move done as written leads to a passing run; the simulated
`a link` case of the case-sensitive disk test now patches `os.path.islink`
too and expects no warning. Links are made with `os.symlink`, and a test
skips first where the system refuses one. No link is made under
`templates/`.

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… disk with a separate `InkRouter` folder is skipped on Windows, where WindowsPath equality ignores case, so tests-windows no longer fails on a layout a Windows disk cannot hold (#543)

Found by rv543b. `same_directory()` asks equal paths first, and a
WindowsPath compares without case, so on Windows `<p>/InkRouter` and
`<p>/inkrouter` are one path and the case-only branch prints the folder
rename. That answer is right for Windows, whose disk cannot hold two folders
that differ only in case, but it is not the case-sensitive disk this
parameter simulates. The `[a folder]` parameter is now skipped there by a
`skipif` mark, before any fixture or call; `[nothing]` and `[a link]` still
run everywhere.

Emulated on Linux with rv543b's mechanism (`pathlib._is_case_sensitive`
returning False during each test's call): the file gives `1 failed, 24
passed` with the parameter collected, `os.name` being `posix` here, and `24
passed, 1 deselected` without it. Without the emulation: `25 passed`.

A second commit rather than an amend: the round's rules forbid amending.

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ide the holder's parent folder and leading to it, passes the folder check as a link does, so a family folder reached through a junction no longer stops with a printed move that cannot run (#543)

Round 4, from rv543b's review of 0112dcb.

- S-1. `family_link` asked only `os.path.islink`, which is False for an
  NTFS directory junction, the link Windows makes without privilege.
  `Path.resolve()` follows a junction, so that layout stopped and its
  printed `mv` failed, where bfed143 warned and cloned. It now accepts
  `os.path.isjunction` too (Python 3.12 and later, False off Windows),
  read with `getattr` so an older Python still runs the file. Not an "any
  alias" rule: that would make a link spelled in another case a dead end
  on macOS.
- F2. AGENTS.md family item 5 says "(nor linked as it)", as the holder's
  README.md and AGENTS-shape.md already do, rewrapped within the same eight
  lines by dropping one "yourself". AGENTS.md stays at 490.
- F3. The comment beside the case-only rename no longer says the two rules
  never meet: a link spelled in another case stops on Linux, with a staged
  move that runs, and passes on a disk that ignores case. The Windows skip's
  reason now says the simulation assumes Windows' default path equality,
  since an NTFS folder made case-sensitive can hold the two folders.
- F4. A test for each condition no test guarded: `init --work-dir` into a
  folder named after the family keeps the promise; a blank `tracking_branch`
  is not a branch name; a second path to the folder under another name,
  neither link nor junction, does not get the case-only folder rename.

Tests: tests/test_family_siblings_placement.py, 29 tests, among them a
simulated junction that every system runs.

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Oct 15, 2026

Copy link
Copy Markdown

Sorry @brettheap, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 1 day and 8 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@sonarqubecloud

Copy link
Copy Markdown

brettheap added a commit that referenced this pull request Oct 15, 2026
…es not have as the index has it (missing, unstaged, untracked, or behind assume-unchanged or a sparse checkout), so neither commits a change to it nobody staged (#407) (#571)

`family.py remove` commits `.gitmodules` as `git rm` leaves it in the work tree, and `git rm` edits only a `.gitmodules` the work tree has. With the work-tree copy deleted and the deletion not committed, `git rm` edited nothing. `_commit_one` then staged the deletion, and the commit took `.gitmodules` out of HEAD, with every other member's section in it. `remove` exited 0, and the holder it ran in passed its own gate. Once the commit was pushed, a recursive clone left every remaining member empty.

The issue's reproduction, run on bfed143 (I added one `git switch -c`, because #487 landed after the issue was filed):

```
registration keys before: Atlas 2, Nova 2
dry run: exit 0
gitmodules   none: git reads no section of .gitmodules in the work tree as giving members/Nova, so none is removed
remove: exit 0
  committed 766cfa532913: .gitmodules, members/Nova, family.yaml
 .gitmodules  |  6 ------
HEAD holds .gitmodules: no
registration keys after: Atlas 2, Nova 0
family ok: Fam (fam), 1 member(s)
recursive clone: exit 0
the clone's members/Atlas holds 0 entries
REFUSED member-uninitialized: members/Atlas is not an initialized submodule checkout, ...
fatal: No url found for submodule path 'members/Atlas' in .gitmodules
```

One check, `_checked_gitmodules_as_staged`, runs before any git command that writes. The dry run makes it too, in the same words. It reads the index's records for `.gitmodules` (stage, blob and git's `-v` flag letter) in one `git ls-files -s -v -z`, which writes nothing.

- **`gitmodules-missing`** (`remove`): the work tree has no `.gitmodules`, while the index (at any stage) or HEAD has one. The remediation names the restore git takes in that state:
  - `git checkout -- .gitmodules` (the index's copy);
  - `git checkout HEAD -- .gitmodules`, where the deletion is staged;
  - for an unmerged file, by the stages the index holds: `git checkout --merge -- .gitmodules` where it has both sides' copies; `git checkout --ours` where only this side's is left (the other side deleted it); `git checkout --theirs` where only the other side's is; `git checkout-index -f --stage=1` where both sides deleted it. Each is followed by `git add .gitmodules`.
- **`gitmodules-unstaged`** (`remove` and `add`): the work tree's copy is not the index's. That means one of:
  - git lists it as modified (`git ls-files -m`). Where `git add` would still stage the index's own blob from it (`git hash-object --path=.gitmodules` says so, and it is a regular file), the refusal adds that the difference may be its line endings alone;
  - it is unmerged;
  - its deletion is staged while the file is still on disk;
  - the index marks it assume-unchanged, which `ls-files -m` does not look past, and its content is not the index's blob;
  - it is untracked: neither the index nor HEAD holds one. This includes the first member's `add` in a new holder.

  The remediation offers both ways out: stage the work tree's copy, or put back the index's (or HEAD's) copy. Behind assume-unchanged, staging first takes the mark off (`git update-index --no-assume-unchanged -- .gitmodules`), because `git add` stages nothing while it is on. An untracked file is staged with `git add -f .gitmodules`, since an operator's global excludes may match it (and, if wanted, committed on its own first), or moved out of the holder.
- **`gitmodules-sparse`**: the index marks `.gitmodules` skip-worktree, as a sparse checkout that leaves it out does. git neither compares nor stages that file, and `git checkout -- .gitmodules` matches nothing. The remediation is `git sparse-checkout disable`.
  - `add` refuses it whatever the file's state, since `git submodule add` cannot stage it.
  - `remove` refuses it where the file is missing or is not the index's copy, and commits a clean copy on disk rightly, as it did on bfed143.

Every refusal ends with "No git command that writes was run and nothing was written.", and every remediation ends with "run the same command again". Typed as printed, each one leads to the right commit (the tests do exactly that).

`remove` asks this first, before #360's `member-path-registered-twice`. `add` asks it after its mount-path refusals (#242, #300), which already name what they find in the same file. Two of those, `member-name-taken` and `gitmodules-unreadable`, have the person mend the file by hand and run `add` again. They now say "then `git add .gitmodules`", as #300's and #360's remediations already did. Without that step, the run again was this PR's own `gitmodules-unstaged`. The holder's `validate-family.py` keeps its words: it reads the work tree's copy, so re-running it needs no stage.

| Point | What changed |
|---|---|
| S1 | `member-name-taken` and `GITMODULES_UNREADABLE` say "then `git add .gitmodules`". New test: each one's state, mended by hand, the printed stage typed, and `add` then mounts the member. The text tests are updated (`test_family_add_excludes.py`'s `member-name-taken` test, and `test_refusal_default_remediation.py`, which now holds `add`'s remedy equal to the gate's but for the one step). `test_family_add_refusals.py::test_a_gitmodules_git_cannot_read_is_a_refusal_not_a_pass` pins the validator's text, which is unchanged, so it is untouched, and so is the `:518` test, which asserts only the REFUSED line. |
| N1 | The line-endings clause, only where `hash-object` gives the index's blob from a regular file. Tested with a CRLF copy (clause) and a link to the very same bytes (no clause: `hash-object` reads through the link, but git would stage the link). |
| N2, sparse | `gitmodules-sparse`, with `git sparse-checkout disable`. Tested by a real `git sparse-checkout set --no-cone '/*' '!/.gitmodules'`, for both verbs, typed as printed. |
| N2, modify/delete | The per-stage restores above. Tested for stages 1+2 (`--ours`), 1+3 (`--theirs`) and 1 alone (`checkout-index`), each typed as printed. |
| N3 | `test_a_holder_whose_head_has_no_gitmodules_is_not_asked` asserts only that no `gitmodules-` refusal is made. Its docstring says the real run fails there, a known case from before #407 that goes to #459. |
| N4 | The base split below is corrected. |
| N5 | `unmerged()` and `typed_as_printed()` run git through `raw(root, env, ...)`, under the module's isolated environment. `raw()` gained a `stdin` argument for `update-index --index-info`. |
| N6 | `held()` and `assert_held()` are gone. Refusals are read with `test_family_dry_run.state()` and `assert_as_it_was()`; `state()` now reads a missing `.gitmodules` as None (three lines). |
| Codex, `:4476` | The untracked `.gitmodules` is `gitmodules-unstaged`, for both verbs, dry run alike. Tested: the first `add` in a holder with no member, and `remove` in the holder #407 leaves behind with the old bytes put back untracked. Staged as printed, each commits. |
| Codex, `:4519` | assume-unchanged: compared by content (`hash-object` against the stage-0 blob) and refused. skip-worktree: `gitmodules-sparse`, as for N2. Tested for both verbs: the assume-unchanged edit kept through the printed `update-index` and `add`, and the skip-worktree edit through `git sparse-checkout disable`, then the restore the next refusal prints. |

| Nit | What changed |
|---|---|
| 1 | `remove` again commits a clean `.gitmodules` the index marks skip-worktree, as bfed143 and b1120c3 did: `gitmodules-sparse` is asked for `add` whatever the file's state, and for `remove` only where the file is missing or is not the index's copy. `add`, an edited file and a missing one stay refused. The function's and the module's docstrings say which verb refuses what. New test: `remove` with the mark on and the file clean commits exactly `.gitmodules`, `family.yaml` and the gitlink. |
| 2 | Two cases the round-2 tests left open. X1: `add` over a file marked both skip-worktree and assume-unchanged (two `update-index` calls, `ls-files -v` tag `s`) is `gitmodules-sparse`. X2: a clean assume-unchanged file passes, and both verbs commit the right tree. Each set-up asserts the `ls-files -v` letter it expects. |
| 3 | The untracked branch prints `git add -f .gitmodules`. The untracked `add` test also runs under an operator's `core.excludesFile` holding `*` (set as #242's tests set it), asserts that the file is ignored there, types the remedy, and `add` commits. |
| 4 | Decision 5's wording. Round 2's commit subject said "no printed command leads into another refusal", which is inexact: for an edit hidden by skip-worktree, `git sparse-checkout disable` leads, by design, into `gitmodules-unstaged`, and `test_an_edit_skip_worktree_hides_is_refused_then_named_as_modified` pins that chain. This round's commit subject says only what it does. |

1. **Refuse, not rebuild (the issue's first option).** The holder is left byte for byte as it was, and the person picks the copy they mean. Building this member's section out of the index's blob would commit a `.gitmodules` the work tree does not have. The holder would then show `.gitmodules` as deleted, and the person's next `git commit -a` would delete it after all. For a modified copy it would also have to guess which copy the person means.
2. **A staged change still goes in.** The remediations of #360 and #300 tell the person to edit `.gitmodules`, `git add` it, and run the same command again. So the rule is "the work tree's copy must be the index's", not "must be HEAD's".
3. **"Modified" is git's own answer.** It comes from `git ls-files -m`, the comparison `git status` uses and the one `git rm` refuses an unstaged change with. On bfed143, an unstaged edit, a CRLF-only copy and a symlink were each refused by `git rm` only after `git submodule deinit -f` had emptied the member (then rolled back), and each dry run exited 0. The CRLF case is still refused (as `git rm` refuses it), and now says why it may look like no change: its `hash-object` is the index's blob (probe: both `26f54704`).
4. **Assume-unchanged is compared by content; skip-worktree is refused outright.** Probes against round 1's check (`states-wip.log`):
   - assume-unchanged, clean: both verbs commit correctly, so it is not refused. Edited: `ls-files -m` is empty and both verbs committed the edit. `git add .gitmodules` with the mark on exits 0 and stages nothing (the hash stays `a2d4d491` against the index's `26f54704`), so the keep-remedy takes the mark off first. `git checkout -- .gitmodules` restores it with the mark on.
   - skip-worktree, file on disk: `remove` committed a hidden edit; `add` failed at its mount even for a clean file (`git add` refuses a path outside the sparse-checkout definition, then rollback). `git add` and `git checkout --` both fail while the mark is on. So `add` refuses any skip-worktree `.gitmodules`, on disk or not. `remove` refuses one that is missing or is not the index's copy, and commits a clean one on disk rightly, as it did on bfed143 and b1120c3 (round 3; round 2 refused that one too).
5. **`git sparse-checkout disable` is the one command that works as typed both in a sparse checkout and where only the mark is left.** `git sparse-checkout add /.gitmodules` is narrower in a real non-cone sparse checkout, but fails for a mark set by hand (`fatal: no sparse-checkout to add to`). With sparse checkout on, `git checkout --ignore-skip-worktree-bits -- .gitmodules` and `git update-index --no-skip-worktree` + `git checkout --` both put the file back, but `remove` then failed at its commit's `git add` ("outside of your sparse-checkout definition"). `disable` worked with sparse checkout on and with only the mark left, and keeps a copy already on disk as it is. The refusal names the state in its own words. It is a dozen lines, not a sparse-definition reader.
6. **An untracked file is staged, not committed by the printed command, and staged with `-f`.** `add`'s branch check (#487) comes after this refusal, so a printed `git commit` could land on the tracking branch. Staged, the file goes into the verb's commit; the remediation says to commit it on its own first if that is not wanted. An operator's global excludes may match the untracked file (#242's `*`), and a plain `git add` then refuses it, so this branch prints `git add -f .gitmodules`. The tracked branches keep the plain `git add`, which stages a tracked file under the same excludes.
7. **The dry run (N9).** In the issue's state, `remove --dry-run` prints the same refusal, exit 2. Past the refusal, the work tree's file is the index's copy, or no copy exists anywhere. So `deinit` reads the same name the dry run reads.
8. **`bump` is not affected.** Its commit is `[path, MANIFEST]` and never stages `.gitmodules`. Probe: `bump` with the work-tree `.gitmodules` deleted committed `family.yaml` and `members/Atlas` only.

`tests/test_family_remove_gitmodules.py`, 35 tests:
- `remove` over each state the work tree lacks (6): deleted (the issue), deletion staged, and unmerged with the file deleted at stages 1+2+3, 1+2, 1+3 and 1. Both runs refuse alike, exit 2, nothing on stdout, and the holder unchanged: `test_family_dry_run.state()`, which is HEAD, `ls-files -s -z`, `status --porcelain=v1 -z`, `family.yaml`, `.gitmodules`, `.git/config`, the member's HEAD, every work-tree byte and the holder's objects. The remedy is typed as printed; `remove` then exits 0, HEAD's `.gitmodules` gives only the other member's path, and the gate passes;
- the issue's clone: after the restore and `remove`, a push and a fresh `clone --recurse-submodules` populate the other member, and the clone's gate exits 0;
- each work-tree copy that is not the index's, for both verbs (12): edited, CRLF only, a link to the same bytes (skipped on Windows), assume-unchanged and edited, unmerged, deletion staged with the file kept. One printed remedy is typed, and the verb then commits;
- sparse (4): a real sparse checkout for both verbs, and `add` over a clean file marked skip-worktree by hand and over one marked both ways (`ls-files -v` tag `s`); skip-worktree with an edit (2), both verbs;
- a clean file behind a mark, committed with exactly `.gitmodules`, `family.yaml` and the member's gitlink (3): skip-worktree (`remove`), assume-unchanged (`remove` and `add`);
- untracked (3): `add` in a new holder, with no excludes and under an operator's `*`; `remove` in a holder #407 already damaged;
- `add` over a missing file is still git's own refusal, with its dry run's note;
- a holder whose HEAD lost `.gitmodules`: no `gitmodules-` refusal (N3);
- S1 (2): `member-name-taken` and `gitmodules-unreadable`, mended by hand, the stage typed as printed, `add` then mounts.

Round 2's 29 tests on round 1's head b1120c3: `15 failed, 14 passed in 80.15s`. The 15 are exactly round 2's cases: CRLF's clause (2), sparse (2), skip-worktree (2), untracked (2), S1 (2), the `--ours`, `--theirs` and `checkout-index` restores (3), and assume-unchanged (2). On bfed143 with them: `27 failed, 2 passed in 59.67s`; the 2 that pass pin behaviour the fix keeps (`add` leaves a missing file to git, and N3's holder is not asked).

Round 1's base proof, corrected (the review's N4): on bfed143 with round 1's 14 tests, `12 failed, 2 passed`. Of the 12, 8 failed on "HEAD changed" (the verb committed; the clone test is among them), 3 on ".git/config changed" (`lacks[deletion staged]`, `[edited-remove]` and `[crlf-remove]`: the run failed after `deinit` and the rollback re-wrote the registration) and 1 on "status changed" (`[unmerged-remove]`). In `lacks[deletion staged]` it was not `git rm` that failed after `deinit` but `_commit_one`'s `git --literal-pathspecs add -f -- .gitmodules family.yaml` (`pathspec '.gitmodules' did not match any files`).

On this head (ebe6b51), Linux, `/usr/bin/python3 -m pytest`, the files round 3 touches and the importers of the changed helpers: `tests/test_family_remove_gitmodules.py tests/test_refusal_default_remediation.py tests/test_family_add_excludes.py tests/test_family_dry_run.py tests/test_family_member_path.py`: `182 passed in 224.37s (0:03:44)`. The new file alone: `35 passed in 46.50s`.

Round 2's targeted runs, on cb159b1 (round 3 changes `family.py`'s skip-worktree condition and one remedy, and the new test file):
- `tests/test_family_remove_gitmodules.py tests/test_family_bump_remove_rollback.py tests/test_family_dry_run.py tests/test_family.py tests/test_cli_reference.py tests/test_repo_hygiene.py tests/test_family_member_path.py tests/test_family_tracking_branch.py tests/test_family_printed_quoting.py tests/test_family_member_name.py tests/test_family_bump_to_a_tag.py tests/test_family_init_landing.py tests/test_family_init_values.py tests/test_template_text_placeholders.py`: `706 passed, 19 skipped in 1013.94s (0:16:53)` (the skips are `test_family_init_values.py`'s template-quoting cases, as on main);
- `tests/test_family_add_refusals.py tests/test_validate_family_duplicates.py tests/test_validate_family_member_path_glob.py tests/test_validate_family_unnamed_mounts.py tests/test_validate_family_without_git.py tests/test_family_add_excludes.py tests/test_family_add_member_id.py tests/test_refusal_default_remediation.py tests/test_agents_md_codes.py tests/test_shape_doctor.py`: `632 passed, 3 skipped in 1482.84s (0:24:42)` (the skips are the Windows-only PowerShell line).

Windows: every file the tests write is written with `write_bytes`, git's stdin gets bytes, and nothing compares against a file a helper wrote with `write_text`. The holder's attributes keep `.gitmodules` LF in the work tree (`i/lf w/lf attr/text=auto eol=lf`). The symlink case skips on Windows, where git checks a link out as a plain file. macOS: no case variants are involved.

The issue's script, with local bare remotes, a `gh` that exits 97, no global or system git configuration, and the registrations read from `.git/config` by `grep`:
- on round 2's head (cb159b1): `dry run: exit 2` and `remove: exit 2`, both `REFUSED gitmodules-missing: ...` with the same stderr, and a full snapshot of the holder (every file, `.git` included) identical after each. The registration sections stay 1 and 1. After a push of the unchanged holder, the recursive clone exits 0, `members/Atlas` holds 15 entries, and the clone's gate prints `family ok`.
- round 1 typed the remedy as printed (`git checkout -- .gitmodules`): `remove: exit 0`, a commit with `.gitmodules | 3 ---` (Nova's section only), the holder's gate exits 0, and after a push the recursive clone populates Atlas and its gate exits 0. The lacks and clone tests repeat that on this head.
- round 2's states, on cb159b1: for `remove` and `add`, a real sparse checkout, a skip-worktree edit, an assume-unchanged edit (kept, and dropped), CRLF and a link; for `remove`, an assume-unchanged deletion, the unmerged file deleted at stages 1+2, 1+3, 1 and 2+3, and the untracked file in a damaged holder; for `add`, the untracked file in a new holder. Each is refused alike by both runs (identical stderr), each printed command exits 0 as typed, and the run again commits what the remedy chose. Round 3 changes two of these paths (a clean skip-worktree file for `remove`, and the untracked remedy's `-f`), and its tests on ebe6b51 hold both.

Nothing here needs real GitHub or a cloud tool.

Round 2's code hunks, each reverted alone in a throwaway worktree at cb159b1, with the new file run against it:

| hunk reverted | result | new tests that fail |
|---|---|---|
| M1 S1, `GITMODULES_UNREADABLE`'s stage | 1 failed, 28 passed | S1 `[gitmodules-unreadable]` |
| M2 S1, `member-name-taken`'s stage | 1 failed, 28 passed | S1 `[member-name-taken]` |
| M3 the untracked refusal (Codex, `:4476`) | 2 failed, 27 passed | both untracked tests |
| M4 `gitmodules-sparse` | 4 failed, 25 passed | sparse `[remove]`, `[add]`; skip-worktree `[remove]`, `[add]` |
| M5 the per-stage restores (always `--merge`) | 3 failed, 26 passed | `lacks[our side only, deleted]`, `[their side only, deleted]`, `[neither side, deleted]` |
| M6 the line-endings clause (N1) | 2 failed, 27 passed | `[crlf-remove]`, `[crlf-add]` |
| M7 `_stages_as`'s regular-file guard | 2 failed, 27 passed | `[a link to the same bytes-remove]`, `[...-add]` |
| M8 the assume-unchanged branch (Codex, `:4519`) | 2 failed, 27 passed | `[assume-unchanged, edited-remove]`, `[...-add]` |
| M9 the flags read as `H` (`_gitmodules_in_index`) | 6 failed, 23 passed | the 2 assume-unchanged, 2 sparse and 2 skip-worktree cases |
| M10 the return where nothing holds a `.gitmodules` | 29 errors | every test, at the family fixture's first `add` into a holder with no `.gitmodules` anywhere, which is then refused as untracked |

Round 1's hunks are still held by the same tests (round 1's probes M1 to M8). The other hunks are docstrings and comments.

Round 3's hunks, each reverted alone at ebe6b51, with the new file run against it:

| hunk reverted | result | new tests that fail |
|---|---|---|
| R1 the narrowing (always refuse skip-worktree) | 1 failed, 34 passed | `[skip-worktree-remove]` of the clean-behind-a-mark test |
| R2 its `verb == "add"` arm | 2 failed, 33 passed | sparse `[marked by hand, clean-add]`, `[marked both ways, clean-add]` |
| R3 X1, `tag == "S"` without `.upper()` | 1 failed, 34 passed | sparse `[marked both ways, clean-add]` |
| R4 X2, every assume-unchanged copy refused | 3 failed, 32 passed | `[assume-unchanged-remove]`, `[assume-unchanged-add]`, sparse `[marked both ways, clean-add]` |
| R5 plain `git add` in the untracked remedy | 3 failed, 32 passed | the three untracked tests (the pinned text) |
| R5b plain `git add` in the remedy AND the test's expected text | 1 failed, 2 passed (`-k untracked`) | `[*]`: typing `git add .gitmodules` fails, "The following paths are ignored by one of your .gitignore files ... Use -f" |

`git merge-tree --write-tree` of this head (ebe6b51) with each of these is clean:
- origin/main dd3f23a. Since bfed143, main took #551, #552, #554, #553, #561, #562, #579, #567, #558, #556 and #580; none touches `scripts/family.py` or a test file this branch changes. This branch does not merge main;
- `fix/family-bump-to-checks` 8024f9c (#568), `fix/family-members-case-variants` 8a95345 (#574), `fix/link-source-chain-defaults` a707d4b (#576), `fix/family-siblings-tracking-branch` 2156a01 (#578);
- lane 2's `fix/537-dry-run-asks-remotes` 69c58aa (#573), and #575's head 0680799 (lane 2, which changes `validate-family.py`; its unreadable-file remedy still ends "then run this again.", which `test_refusal_default_remediation.py` expects).

- **(a) `family.yaml` hand edits are committed by `add`, `bump` and `remove`.** Each commits `family.yaml` as the work tree has it, so an unstaged hand edit outside `members:` (a comment line) goes into the commit: the review reproduced `+# a hand note nobody staged` in a commit of each verb. It is #407's rule for a different file, and a staged-only rule there would chain into every remedy that says "edit `family.yaml`, then re-run", as S1 did here. It needs its own issue.
- **(b) A HEAD that already lost `.gitmodules` fails after the first write.** With no `.gitmodules` anywhere, this check asks nothing. `remove --dry-run` exits 0 and says no section is removed; the real `remove` runs `deinit` and `git rm`, then dies at `git --literal-pathspecs add -f -- .gitmodules family.yaml` (`pathspec '.gitmodules' did not match any files`) and puts back only part of the unmount (`members/Nova` is left empty). Same on bfed143. Once the old file is put back in the work tree, this PR now refuses it as untracked, and staged as printed `remove` commits it back into HEAD; but nothing tells the person to do that.
- **(c) The gate passes a row with no `.gitmodules` section (#459, the issue's decision 3).** `validate-family.py` should find a `members:` row whose path no section of HEAD's `.gitmodules` gives. A holder already carrying a #407 commit passes its own gate, and only a fresh recursive clone shows it.
- **(d) A sparse checkout whose rules leave `.gitmodules` out, with the file put back on disk by hand.** git then clears the skip-worktree mark, so this check passes, and `remove`'s commit fails at `git add` ("outside of your sparse-checkout definition") and is rolled back. Nothing wrong is committed; it is a late failure, and reading the sparse rules is not this PR's.

- **(e) A verb run during a merge, cherry-pick or rebase fails after its first writes.** Any `family.py` verb run while one is in progress fails at its commit, `git commit -- <paths>` ("fatal: cannot do a partial commit during a merge."), and is rolled back. It is the same on bfed143. It touches this PR because its `--ours` and `--theirs` restores name modify/delete conflicts, whose commonest source is `git merge`: typed as printed the restore works, then `remove` fails late. The tests build those stages with `update-index --index-info` and no `MERGE_HEAD`, the state a conflicted `git stash pop` leaves. The candidate: refuse an in-progress merge, cherry-pick or rebase before the first write, beside the existing up-front refusals.

Review: rv407 found 1 should and 6 nits on b1120c3; fix round 2 (cb159b1) fixed them and answered Codex's `:4476` and `:4519` threads; re-review rv407b found 4 nits, fixed in round 3 (ebe6b51). CI (Brett Heap's ruling 27): H0 ebe6b51 passed tests, tests-macos, tests-windows and SonarCloud; the head 52c7c88 is a clean update-branch merge of main 2989b4c, with tests and SonarCloud green. Landed on Brett Heap's word of 2026-10-15T13:32:47Z, "All five, once green".

Closes #407

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
brettheap added a commit that referenced this pull request Oct 15, 2026
…e `--link-source` is the first chain link's tree alone, and a source that names no path is refused (#441, #442) (#576)

**README change.** This PR edits one README paragraph. #551 is on main and this branch has merged it, so the handbook step follows #551's rule: the three page parts that read the README section "The three legs" record its new hash. No page text changes.

### #441: one bare tree answered for two links

`link_pins_from_trees` passed its `default_source` to every link of a recorded chain. That value is the naming gate's bare `--link-source PATH`, and the scaffold's `--pin-source`. In the chain `openXdox → openYdox → openInk`, with one bare tree that is `openXdox`'s, `openYdox` was read from the same `project.yaml`. That file declares `openYdox`, not `openInk`, so the gate said "openYdox declares openYdox, not openInk". For `codexInk`, which holds no direct pin on its referent, that was a FINDING, exit 1, for a chain that holds. The scaffold refused the same chain as `chain-not-declared`.

Now:

- **Which links read a bare value (for #540 and anyone else relying on it):** only the FIRST link of each chain, `links[0]`, the pin the project holds. That is true for a chain of any length, one link included: a chain of one link has only its first link, and that link reads the bare tree as before. A later link is never offered the bare value. It is read from its own `LINK=PATH`, its `SHAPE_PIN_SOURCE_<LINK>` or a checkout beside the project; otherwise it is declared-unverified (a warning, exit 0). For the first link the order is unchanged: keyed, variable, checkout beside the project, then the bare value.
- `link_pins_from_trees` and `resolve_link_source` keep their signatures and return shapes. The only code change in `repo_shape.py` is `None if index else default_source` in the loop.
- The two-link case (`openXdox → openDox` with a bare path) reads exactly as before and prints the same lines. The one difference is inside the returned mapping, and only for a chain of two or more links: the chain's END link no longer gets an entry read from the bare tree. Nothing reads that entry; only holders' declarations are read. In a chain of one link the only link is both the first and the end, and it still reads the bare tree, as before.
- In the naming gate, `LinkSources` finds the first link of every chain a name will READ before any chain is read. `_first_links_read` uses the same `reads_link_declarations` test the lookup uses, and counts a chain only if it has two or more links: a chain of one link has no holder, reads no declaration, and so has no first link to count. The bare value is offered only while there is at most one first link: with a lone one-link chain there are none, and the bare tree is still returned for that chain's link to read, as before (nothing reads what it finds, so the output is unchanged). If a run reads two chains that begin at different links (a name on the command line plus `--project`, or one project with two legs), the bare value is read for neither. Before, one tree answered both, and `used` counted it once.
- A bare value no link took is a NOTE saying why. In a two-link run the sentence is the one it always was. In a longer chain it reads "a bare PATH is the tree of a chain's first link alone, openXdox, which had a more specific source (...)". With two first links it reads "the chains read here begin at openXdox, openYdox: name the link it is, as --link-source <link>=PATH".

### #442: an empty path was the current directory

`--link-source openXdox=` and `--pin-source openXdox=` became `Path("")`, which is `.`. From a project root, the naming gate read the project's own manifest as `openXdox`'s and called the chain broken. `validate-pins.py` asked the project root for the pinned commit, and its finding blamed `.`.

Now both tools refuse, exit 2, naming the key:

```
REFUSED link-source-no-path: `--link-source openXdox=` names no path for openXdox. An empty path would be read as the directory this runs in. Give the tree's path (`--link-source <link>=<path>`), or `.` to mean this directory.
REFUSED pin-source-no-path: `--pin-source openXdox=` names no path for openXdox. An empty path would be read as the directory this runs in.
Remediation: give the checkout's path (`--pin-source <product>=<path>`), or `.` to mean this directory.
```

- An empty bare value (`--link-source ''`, `--pin-source ''`) is refused the same way.
- A typed `.` still means the current directory.
- A value whose key is NOT a chain link or a declared pin (`openZdox=`) is still the bare PATH `openZdox=`, as #338 and #295 decided. It is not empty, so it is not refused.
- **Behaviour change: an empty value is refused even when a later value replaces it.** `--link-source openXdox= --link-source openXdox=<tree>` was a NOTE ("the later `--link-source ...` replaced it"), exit 0. It is now `REFUSED link-source-no-path`, exit 2. `validate-pins.py` changes the same way: `--pin-source openXdox= --pin-source openXdox=<clone>` was `pins ok`, exit 0, and is now `REFUSED pin-source-no-path`, exit 2. A typo is a typo, and the refusal names it when it is typed; a script that passed an empty value first and the real one after must drop the empty one.
- The naming gate refuses in `main`, right after the values are read and before stdin is read or any name is classified, like its own `REFUSED naming-no-target`.
- `validate-pins.py` raises a `Refusal` from `PinSources`. It reaches `main`'s existing handler with its own remedy, not the lockstep one. **It is raised late:** `PinSources` is built inside `_check_neutral_product_pins`, which `_run_all_checks` calls after `_check_leg` and `_check_shape_pin`. So an earlier refusal wins: a damaged `contracts/spec-pin.yaml` plus `--pin-source openXdox=` prints `REFUSED pin-tag-only`, and the empty path is named on the run after that is fixed. The hunk stays inside `PinSources` on purpose, to stay clear of the lines #539 edits in `_run_all_checks`. The refusal also has to wait for the declared pins, because they decide whether `openXdox=` is keyed or a bare PATH. Nothing is printed before the refusal, and the exit is 2 as in every other refusal of that tool.

### Docs

- `--help` for `--link-source`, the naming validator's module docstring (exit code 2 included), `resolve_link_source`'s rule 4, `link_pins_from_trees`'s docstring and the scaffold's `_declaration` docstring say what a bare value means in a longer chain.
- The `--link-source` help also says that a bare PATH is read for neither link when the chains read begin at two different links, and that a later link is read from its own `PRODUCT=PATH`, its `SHAPE_PIN_SOURCE_<PRODUCT>` or a checkout beside the project (it said "needs its own `PRODUCT=PATH`").
- `docs/cli.md` is regenerated.
- README's lookup-order sentence now reads "then a bare `--link-source <path>`, for the first link's tree only: the order `validate-pins.py` uses below for the same checkout." The paragraph keeps its 12 lines, and README keeps its line count.
- The handbook names no `--link-source`. The three parts that read "The three legs" (the masthead, "Reading private legs in CI", "The three legs, and naming") move to that section's new hash, 6ebed796 → 39ec2c23. No other README section changed.
- `validate-pins.py`'s `--help` and EXIT CODES docstring do not name `pin-source-no-path`. Nothing in them is false: the exit-2 list gives examples. I left them, because the module docstring sits near lines #539 edits.

The review of 04c9d77 (APPROVE WITH NITS) found five nits. Each, and what this commit does:

1. **A chain of one link counted as a first link.** `--referent-chain openInk` beside a project whose leg records `openXdox → openQuill`, with a bare `openXdox` tree, gave two first links, so the bare tree went to neither. `codexQuill`, verified through it on bfed143, was declared-unverified, with a NOTE naming `openInk` as a first link. Both places now count `chain[0]` only when the chain has more than one link: `_first_links_read`, and the `firsts` update in `LinkSources.link_pins`. The run is verified again, with no WARNING and no NOTE, as on bfed143. New test `test_a_chain_of_one_link_is_no_first_link_read`.
2. **A test gap: the project half of `_first_links_read`.** Reverting `if data is not None:` to `if False:` (mutation M14) left all 20 tests passing, yet it changes the output for one project whose two legs begin at different links: the first classification pass counted the bare value used, and the NOTE went missing. New test `test_a_project_whose_legs_begin_at_two_links_reads_a_bare_tree_for_neither`: `openXdox → openInk` and `openYdox → openQuill` in one project, a bare `openXdox` tree, two WARNINGs and the two-first-links NOTE. M14 now fails it (see the mutation probes).
3. **`pin-source-no-path` is raised late in `validate-pins.py`.** No code change. The behaviour and the reason are written above, under #442.
4. **The `--link-source` help.** It now says a bare PATH is read for neither link when the chains read begin at two different links, and "needs its own `PRODUCT=PATH`" now names the variable and the checkout beside the project too. `docs/cli.md` is regenerated, and `render-cli-reference.py --check` is ok.
5. **This body.** It now says: #539 is on origin and merges clean (see the merge checks); an empty value is refused even when a later one replaces it; the END-link sentence holds for chains of two or more links; and the checklist candidate below.

The commit changes `scripts/validate-repository-naming.py`, `docs/cli.md` and `tests/test_link_source_chain_defaults.py` only.

The re-review of 31a6f21 (APPROVE WITH NITS) found that all five nits are fixed, and two new ones. This commit changes `tests/test_link_source_chain_defaults.py` only.

- **A test gap at the two-link boundary of `link_pins`.** Changing `if len(target.chain) > 1:` there to `> 2` passed the whole new file and `tests/test_naming_policy.py` (264 passed), yet it changes the output for a name read from stdin whose chain has two links: the first-link list is empty, and the NOTE for an unused bare value reads "a bare PATH is the tree of a chain's first link alone, , which had a more specific source". New test `test_a_two_link_chain_read_from_stdin_counts_its_first_link`: stdin `codexInk`, `--referent-chain openXdox,openInk`, `openXdox=<tree>` keyed and a second tree bare, asserting the whole stderr, the one NOTE "each link whose own declaration is read had a more specific source (...)". The `> 2` mutant fails it (see the mutation probes). The existing three-link stdin test and the new one share a helper, `stdin_naming`.
- **This body.** "exactly one first link" now reads "at most one", and the merge paragraph names the current main.

- **First link only, not a refusal.** The coordinator recommended this rule. Nothing documented or tested depended on a bare value answering a later link: no test passes `default_source` to `link_pins_from_trees`, and every scaffold test with a three-link chain sets `SHAPE_PIN_SOURCE_<LINK>` for each link. A refusal "when more than one link would take it" would depend on what is on the disk (checkouts beside the project, variables). #338 ruled that the reading is decided by the chains, never by the disk.
- **Refuse #442, not note it.** A note would still have to stop the value reading `.`. A refusal names the typo when it is typed, and both tools already exit 2 for a question they cannot ask.
- **The scaffold is fixed too.** It reads its `--pin-source` through the same function, so its three-link refusal goes away (see the reproduction). Its `--pin-source` is the pinned product's checkout, which is the first link's tree.

New file `tests/test_link_source_chain_defaults.py`: 23 tests (22 until round 3). On bfed143, 17 fail and 5 pass (the controls: the one-link rows and the rows that already worked). On 04c9d77, the one-link test fails and the other 21 pass.

Targeted runs (each `run9.sh`: `gh` stub, bogus token, empty `GH_CONFIG_DIR`, git-filter-repo 2.47.0), on the head 31a6f21 unless a row says otherwise. Round 3 (head a707d4b) changes the new test file only, and its own run is the last row:

| set | result |
|---|---|
| new file, naming policy, referent-chain links, pin-source env collisions, pin-source unreadable, CLI reference, repo hygiene, README sections, AGENTS.md codes, validate-pins without git, unreadable workflow | `774 passed in 117.48s` |
| manifest validator, scaffold pin and reuse, YAML flow quotes, neutral pin validator | `205 passed in 91.75s` |
| CLI reference alone | `22 passed in 26.08s` |
| template text placeholders, adopt plan leg-path help | `187 passed in 87.54s` |
| predicted merge with origin/main 7d9bec9 (tree 908b3214): repo hygiene, README sections, CLI reference, new file, naming policy | `415 passed in 53.10s` |
| round 3, head a707d4b: new file, naming policy, CLI reference | `287 passed in 95.29s` |

Round 1 (head 73c4c255, before the merge of #551 and this commit; `docs/handbook.html`, `README.md` and the validators are unchanged by this commit apart from `validate-repository-naming.py`):

| set | result |
|---|---|
| doctor, doctor validator rows, scaffold e2e, setup-project.py, setup.sh, adopt e2e, adopt pins, adopt spec-only, adopt submodules, adopt ignored shape files, adopt plan YAML quoting, adopt root symlinks, scaffold leg-path collisions, update-shape landing | `27 failed, 1796 passed, 3 skipped in 1433.51s`; every failure the same `UnicodeDecodeError` from a bytecode file my own `py_compile` probe had left in `templates/assembly-root/scripts/__pycache__`. With it removed, the two files that held all 27 (`test_adopt_root_symlinks.py`, `test_scaffold_leg_path_collisions.py`) gave `253 passed in 140.50s` |

The three skips are `test_shape_doctor.py:9119`, which runs only on a Windows host. None of those files passes `--link-source`, and the one-link change and the help text cannot change a run that gives no bare value.

**The 27 failures.** `template_values()` and its twin in `test_scaffold_leg_path_collisions.py` read every file under `templates/assembly-root` as UTF-8. A `validate-pins.cpython-312.pyc` had appeared there the second I ran `python3 -m py_compile` over the changed files. Its first byte is `0xcb`, the 3.12 bytecode magic, which is the byte every failure names. CI never runs `py_compile`.

| row | bfed143 | this head |
|---|---|---|
| #441: one bare `--link-source <openXdox tree>`, chain `openXdox → openYdox → openInk`, `codexInk` | `FINDING ... is broken (openYdox declares openYdox, not openInk)`, exit 1 | `domain-descendant/assembly`, one `declared-unverified` WARNING for openYdox naming `--link-source openYdox=<path>`, exit 0 |
| #441: each link keyed | exit 0 | exit 0, unchanged |
| #441: no `--link-source` | two WARNINGs, exit 0 | unchanged |
| #441, scaffold `--dry-run`, same chain, `--pin-source <openXdox clone>` | `REFUSED chain-not-declared`, exit 2 | WARNING declared-unverified for openYdox, plan printed, exit 0 |
| #441, one link: `--referent-chain openInk` beside a leg `openXdox → openQuill`, bare openXdox tree | no warnings, exit 0 | the same: no warnings, exit 0 (04c9d77 printed a WARNING and a NOTE) |
| #441, one project, legs `openXdox → openInk` and `openYdox → openQuill`, bare openXdox tree | `FINDING codexQuill: the declared chain openYdox → openQuill is broken (openYdox declares openInk, not openQuill)`, exit 1: the bare tree answered both first links | two WARNINGs and the two-first-links NOTE, exit 0 |
| #442: `--link-source openXdox=` from the project root | `FINDING ... (openXdox declares openXdox, not openInk)`, exit 1 | `REFUSED link-source-no-path`, exit 2 |
| #442: the same from another directory | WARNING about `.`, exit 0 | `REFUSED link-source-no-path`, exit 2 |
| #442: `--link-source ''` from the project root | FINDING, exit 1 | `REFUSED link-source-no-path`, exit 2 |
| #442: `--link-source openXdox= --link-source openXdox=<tree>` | NOTE "the later ... replaced it", exit 0 | `REFUSED link-source-no-path`, exit 2 (the behaviour change above) |
| #442: `--link-source openXdox=.` from the project root | FINDING (reads the project's own manifest, as typed) | unchanged: a typed `.` is read |
| #442: `--pin-source openXdox=` (scaffolded `codexDox`) | `FINDING neutral-pin-source-unreadable: ... . (--pin-source openXdox=...)`, exit 1 | `REFUSED pin-source-no-path`, exit 2 |
| #442: `--pin-source ''` | the same FINDING, exit 1 | `REFUSED pin-source-no-path`, exit 2 |
| #442: `--pin-source openXdox= --pin-source openXdox=<clone>` | `pins ok`, exit 0 | `REFUSED pin-source-no-path`, exit 2 |
| control: `--pin-source openXdox=<clone>` | `pins ok`, exit 0 | unchanged |

No row needs real GitHub. Round 1 ran every row except the two new ones and the two "a later value replaces it" rows. The one-link and two-legs rows are the new tests: on bfed143 the one-link test passes and the two-legs test fails; on 04c9d77 the one-link test fails and the two-legs test passes. The two "a later value replaces it" rows are the review's reproductions of bfed143 against 04c9d77; this commit does not change them.

Each hunk was reverted alone in a throwaway worktree, and the new file run against it.

Round 1 (20 tests), every hunk fails at least one test:

| hunk reverted | tests that fail |
|---|---|
| `repo_shape.py`: offer `default_source` to every link again | 6: the long-chain row, the later-link NOTE, the stdin NOTE, the lookup `[two]` and `[three]`, the scaffold |
| `LinkSources._bare_path`: drop the two-first-links gate | 1: two chains beginning at two links |
| `_not_asked_why`: drop the two-first-links sentence | 1: the same test |
| `_not_asked_why`: always the old two-link sentence | 2: the later-link NOTE and the stdin NOTE |
| `main`: drop the `link-source-no-path` refusal | 6: every `--link-source` no-path row |
| `PinSources`: drop the `pin-source-no-path` refusal | 3: every `--pin-source` no-path row |
| `link_pins`: drop `firsts.setdefault` (stdin names) | 1: the stdin NOTE |
| `_first_links_read`: return nothing | 1: two chains beginning at two links |
| naming `no_path`: keyed values only | 2: the two empty bare rows |
| pins `no_path`: keyed values only | 1: the empty bare row |

Round 2 (22 tests, head 31a6f21):

| hunk reverted | tests that fail |
|---|---|
| `_first_links_read`: `if data is not None:` → `if False:` (the project's legs; the review's M14, which survived 04c9d77) | 1: `test_a_project_whose_legs_begin_at_two_links_reads_a_bare_tree_for_neither`; stderr has the two WARNINGs and no NOTE |
| `LinkSources.link_pins`: count a one-link chain's first link again | 1: `test_a_chain_of_one_link_is_no_first_link_read` |
| `_first_links_read`: count a one-link chain again | 1: `test_a_chain_of_one_link_is_no_first_link_read` |

Round 3 (23 tests, head a707d4b):

| hunk changed | tests that fail |
|---|---|
| `LinkSources.link_pins`: `if len(target.chain) > 1:` → `> 2` (the re-review's boundary mutant, which survived 31a6f21) | 1: `test_a_two_link_chain_read_from_stdin_counts_its_first_link` (`1 failed, 22 passed in 10.59s`); stderr has "first link alone, , which had" where the test expects "each link whose own declaration is read had" |

The existing `test_a_link_source_no_link_used_is_a_note_and_changes_no_exit` in `tests/test_naming_policy.py` holds the two-link NOTE sentence byte for byte, and it passes.

- origin/main 9f80939 (it holds the README, handbook and `tests/readme-cap.d/550.txt` of f6eaab7): clean. The re-review found it clean at 31a6f21 (tree 71ea0d30), and `test_repo_hygiene.py`, `test_readme_sections.py` and `test_cli_reference.py` gave `151 passed in 58.81s` on that merged tree, with `render-cli-reference.py --check` ok. The README cap there is 1427 = 1422 + 5 from main's `tests/readme-cap.d/550.txt`, and this PR adds 0 README lines; its three handbook markers for "The three legs" are 39ec2c23 on the merged tree. a707d4b changes the test file only: merge-tree of it with 9f80939 is clean (tree dfc650f). Earlier mains were clean too: 7d9bec9 (after #552, #553, #554, #561 and #562; `415 passed` on the merged tree) and bbcfd34 (tree 10acc9c). The two `docs/cli.md` regenerations (this PR's `--link-source` help, #561's `bump-leg.py`) touch different tools' sections.
- Lane 2's `fix/539-validators-lockstep-remedies` (#575, 93b68f6), now on origin: clean. The reviewer ran the lockstep-lines test, the new file, `test_validate_pins_without_git.py` and `test_validate_pins_unreadable_workflow.py` on the merge with 04c9d77: `103 passed in 48.45s`. This commit does not touch `validate-pins.py` or any of those tests. The `validate-pins.py` hunk stays inside `PinSources`, away from #539's regions (`:99-544` and `:1109-1143`).
- Lane 2's `fix/540-pin-source-unread` (#570, 79dfd33): clean. On a merge with 04c9d77, the new file, `test_pin_source_unreadable.py`, `test_scaffold_referent_chain_links.py`, `test_scaffold_leg_path_collisions.py`, `test_cli_reference.py` and `test_adopt_pins.py` gave `371 passed`. #540 counts any `--referent-chain` as a reader of `--pin-source`; that stays true, because every chain's first link reads it. One sentence of #540 needs a word once both are in: `pin-source-unused` says the clone is read for "each --referent-chain link's declaration" (`scripts/shape_materialize.py:2706-2707` and the docstring at `:2681-2683`, and `tests/test_pin_source_unreadable.py:445`, the `UNUSED` text at `:455-457` and `:498`). After this PR it is the FIRST link's alone. Whichever lands second should change "each" to "the first".
- The other PR heads #556 to #582 that git still serves (23 heads; #561 is on main): all clean, except #577 (`install.sh`, d0cdbf4). #577 conflicts with main itself, in `docs/handbook.html` and `tests/test_repo_hygiene.py`; against this head the same two files conflict. This PR is not the cause. Both edit `README.md` and the handbook's hash markers, so they land one at a time. Only #575 touches a file this PR changes (`validate-pins.py`, clean).
- Lane 5's other branches: #568 `fix/family-bump-to-checks` 8024f9c, #571 `fix/family-remove-gitmodules-missing` b1120c3, #574 `fix/family-members-case-variants` 40eda84 and #578 `fix/family-siblings-tracking-branch` 43d32eb: clean.

- The scaffold's and `adopt-project.py`'s own `--pin-source ''` (see the checklist candidates).
- `validate-pins.py`'s `--help` and module docstring: nothing in them became false, and the module docstring sits near lines #539 edits.
- Making `validate-pins.py` refuse the empty path before its leg and shape-pin checks: it would put the hunk in `_run_all_checks`, where #539 edits.
- The v1.0.0 release notes keep #441 and #442 as known limits of 1.0.0, which they are.

- **`scaffold-project.py` and `adopt-project.py`: `--pin-source ''` is `Path("")`, so the current directory is read as the pinned product's clone.** Both take `--pin-source` as `type=Path`, and `shape_materialize.declared_pin_values` computes the digest from it. The scaffold also hands it to `link_pins_from_trees` as the first link's tree. Run from the product's own clone, `scaffold-project.py --pin openXdox@<sha> --pin-source '' --referent-chain openXdox,openDox --dry-run` plans with `local-clone (.)`, exit 0; run from anywhere else it reads whatever directory it stands in. This is #442's shape in the two tools that create a project, and neither was in #442. (The review confirmed it for the scaffold on the head; `adopt-project.py` was not re-run.)
- **The scaffold's `declared-unverified` warning names remedies the scaffold does not have.** It says "(a sibling checkout, SHAPE_PIN_SOURCE_<LINK>, or --link-source <link>=<path> would let it be read)". `scaffold-project.py` has no `--link-source` (none in its `--help`) and reads no sibling checkout: `link_pins_from_trees(chain, None, ...)` at `scaffold-project.py:799` passes no root. The text is `_chain_link_findings`' (`scripts/repo_shape.py:1419`). It was already printed on bfed143 for a two-link scaffold with no manifest. Since this PR, every chain of three or more links scaffolded with `--pin-source` alone prints it for the second link, where only `SHAPE_PIN_SOURCE_<LINK>` helps. The wording should name only the remedies the caller has.
- **`tests/test_cli_reference.py` alone writes `templates/family-root/scripts/__pycache__/bootstrap.cpython-312.pyc`** (proved on 04c9d77 and on two merged trees: `22 passed`, then the file is there). A `.pyc` under `templates/` breaks `template_values()` and its twin in `test_scaffold_leg_path_collisions.py` in any later adoption run in the same tree: round 1's 27 failures were the same kind of break, from a `.pyc` under `templates/assembly-root`. #554's `load_without_bytecode` does not cover it. It is outside #441 and #442, and is named here only.

Review: rv441 found 5 nits on 04c9d77 (APPROVE WITH NITS), fixed in 31a6f21; re-review rv441b found all five fixed or answered and 2 new nits (a test gap at the two-link boundary of `link_pins`, and this body), fixed in a707d4b. CI (Brett Heap's ruling 27): H0 a707d4b passed tests, tests-macos, tests-windows and SonarCloud; the head 8971ad5 is a clean update-branch merge of main bcfa364, with tests and SonarCloud green, and the local gate passed on its predicted squash: the scaffold, pins, naming, link-source, setup-by-hand and hygiene sets, 1174 passed, over bcfa364; then the hygiene, AGENTS.md-code, README-section, CLI-reference, link-source and naming sets, 468 passed, over 526cd2c; and 334 passed over b9f65be. Landed on Brett Heap's word of 2026-10-15T13:32:47Z, "All five, once green".

Closes #441
Closes #442

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
brettheap added a commit that referenced this pull request Oct 15, 2026
…, any path under another spelling of `members/`, in its index, in HEAD or on disk, and names a remedy per entry that never moves the members' checkouts (#362, #363, #364) (#574)

Brett Heap ruled on 2026-10-14, "Refuse on every disk": refuse before reading the member, name the entries and a committed `git mv` as the remedy, use one rule for the index, HEAD and the disk, and give the same answer on Linux, macOS and Windows, as #318's any-case rule for the mount path does. The cost he accepted: a Linux holder with its own `Members/` folder renames it first.

What went wrong before, all reproduced on bfed143:

- **#362, the index.** With `core.ignorecase` set, an index entry `Members/README` made git stage every new gitlink as `Members/<P>`. The commit, whose pathspec is `members/<P>`, matched nothing, and the remedy the refusal printed failed the same way every time. With `core.ignorecase` unset, the add committed and left `Members/` beside the member, ready to break the next clone on macOS or Windows.
- **#363, HEAD.** HEAD held `Members/README.md`, and an uncommitted `git rm -r Members` had taken it out of the index. `add` then committed the gitlink as `Members/<P>` with exit 0, while `.gitmodules` and `family.yaml` said `members/<P>`. A fresh clone left the member empty and failed `member-gitlink-absent`.
- **#364, the disk.** `_checked_mount_path` checked the disk with an exact `os.path.lexists`. An untracked `Members/<P>` was refused on macOS and Windows, and on Linux the member was mounted beside it.

What `add` asks now, in `_checked_mount_path`, before it clones, fetches or mounts anything, and before it prints anything about the member:

1. **Which directory is `members/` on this disk (`_members_dir_on_disk`).** The holder's root is listed for every spelling of `members`, with ASCII case folded. `members` is `members/` where it is listed. Where it is not, a directory under another spelling is `members/` itself only when the disk says so: `os.path.isdir(root/'members')` is true and `os.path.samefile(root/'members', root/<spelling>)` names the same directory. That happens on macOS and Windows, never on Linux, and never for a link.
2. **The mount path in that directory, by listing.** An exact `<P>` there gets the same `already exists` refusal as before, word for word. Under another spelling that is `members/` itself, the exception is a `<P>` the index holds under another spelling; the next two questions name that.
3. **#318's any-case index check of the mount path.** Its text and `git rm -r --cached` remedy are unchanged where every variant it holds has nothing on disk. A variant that is on disk goes to the next question instead, which renames it.
4. **`_members_spellings`.** It looks in three places, and gives each path the remedy that acts on it:
   - every index entry under a spelling of `members/` other than `members/` itself, and every case variant of the mount path;
   - every file and gitlink HEAD holds there that the index no longer holds (`git ls-tree` of HEAD's root tree, then of each matching entry's object, with no pathspec; an unborn HEAD holds nothing);
   - what the disk holds there and no index entry covers.
5. **`lexists` of the mount path**, still asked, last, for a directory no listing could read.

The refusal (`_spellings_refusal`):

- It names each path in its own spelling and says where it was found: `in the index`, `in HEAD and no longer in the index`, or `on disk and untracked`. Each place names at most five paths, then a count.
- **Every remedy acts on one entry, never on another spelling's directory.** On macOS and Windows `Members/` and `members/` are one directory, holding the members' checkouts, so a rename of `Members` would move them all. The entry is the one directly under the other spelling (`Members/README`, `Members/docs`, `Members/<P>`), or the spelling itself where it is a file or a link. Where that entry's name folds to one `members/` itself tracks (`Members/irrs` beside `members/IRRS`), it is the full entry instead.
- The remedies run in this order:
  1. what HEAD holds and the index no longer does: commit the pending change first (`git commit`);
  2. what the index holds:
     - on disk in its own spelling: `git mv -- <entry> <new name>`;
     - kept off disk by a sparse checkout: `git mv --sparse -- <entry> <new name>`;
     - nothing on disk: `git rm -r --cached -- <entry>...`, which touches no file;
     - then a commit, where there is something to commit;
  3. what is on disk and untracked: `mv -- <entry> <new name>`;
  4. a `members/` renamed by hand on Linux: `mv -- Members members`.
- Every path in a command is quoted for a POSIX shell (`shell_quoted(..., 'posix')`, #532).
- The holder stays byte-identical. The tests compare the snapshot of `tests/test_family_add_refusals.py` and the whole index, byte for byte.

Example: #364's state on Linux, an untracked `Members/Atlas` in a holder that has `members/Nova`:

```
REFUSED member-path-taken: the family root holds a case variant of members/Atlas, the same path on a case-insensitive disk, though no `members:` row names it — on disk and untracked: `Members/Atlas` (a directory)
Remediation: every member is mounted under members/, and a holder keeps that directory in one spelling on every disk. Move what is on disk and untracked out of the way (`mv -- Members/Atlas <new name>`); then re-run.
```

On macOS and Windows the same `mkdir -p Members/Atlas` lands inside `members/`, which is then the mount path itself. The refusal there is the one it always was, with the same code:

```
REFUSED member-path-taken: members/Atlas already exists in the family root but no `members:` row names it
Remediation: this is a half-finished add or a hand-made directory. Remove it (`git rm -r` if it is tracked), then re-run.
```

Example: #362 on a real disk, a committed `Members/README` beside `members/Nova`. In a fresh clone this text is the same on all three systems. A macOS or Windows holder that PULLED the commit keeps the directory spelled `members`, and gets `git rm -r --cached` instead (a checklist candidate below):

```
REFUSED family-members-dir-variant: the family root holds a path at or under another spelling of members/, which a case-insensitive disk takes for members/ itself — in the index: `Members/README` (a file)
Remediation: every member is mounted under members/, and a holder keeps that directory in one spelling on every disk. Rename what the index holds with `git mv`, entry by entry (`git mv -- Members/README <new name>`), and commit the rename; then re-run.
```

Head `8a95345b` is one new commit on `40eda849`. The review graded one blocker, three should and five nits; Codex added a P2.

- **B1 (blocker): the printed `git mv -- Members` / `mv -- Members` moved every member's checkout on macOS and Windows.** Every remedy now acts on one entry under the other spelling, never on that directory (`_spelled_target`). `_members_dir_on_disk` asks the disk which directory is `members/` (`isdir` + `samefile`). Where it is spelled `Members`, it is treated as `members/` itself: an exact `<P>` in it is `already exists`, a case variant `<p>` is targeted as `Members/<p>`, and an index entry that IS that directory is never renamed. Scenarios `macsingle-mac` and `r318mac-mac` type the new remedy and show `Members/Nova/.git` still in place; `test_the_printed_git_mv_leaves_the_members_where_they_are` does the same in the suite.
- **S1, with Codex's P2 at `scripts/family.py:2099`: rule (b) hid a real Linux variant.** Rule (b) is gone; only the alias that `isdir` + `samefile` confirm is `members/`. On Linux, Codex's state (`members/` renamed `Members`, nothing staged) is refused, and its remedy moves the directory back (`mv -- Members members`). The sign is a member's checkout in it (`Members/<name>/.git`, with the gitlink `members/<name>` in the index) and no `members/` on disk. A human's own `Members/` holding a directory named like a member (`ruleb`) is named entry by entry. `tests/test_family_members_case_variants.py:359-371`, which pinned Codex's case as "not named", is replaced. The layout table asks the same states of an emulated folding disk and an emulated Linux disk on every OS, and `test_a_members_directory_renamed_by_hand_is_moved_back` asserts the answer of the disk the test runs on.
- **S2: `git mv` failed for an index entry with nothing on disk (`bad source`), and for a sparse one (`not under version control`).** Such an entry is now taken out of the index (`git rm -r --cached -- <entry>`, touching no file). The commit after it is printed only where HEAD holds the entry, or will once the pending change is committed. An entry the sparse checkout keeps off disk gets `git mv --sparse -- <entry> <new name>`, which keeps its content. Scenarios `idxonly` and `sparsemv` type each.
- **S3: #318's tracked `Members/<P>/...` took three refusals.** #318's index check now keeps its text only where every variant of the mount path it holds has nothing on disk; its pinned test is unchanged. A variant that is on disk goes to the new refusal: one committed `git mv -- Members/<P> <new name>`, one round (scenario `r318`; `test_a_tracked_path_on_disk_takes_one_committed_git_mv[Members/IRQS/README]`).
- **N1: two remedies collided (`mv: cannot stat 'Members'`).** A disk path the index holds, holds anything above, or (for a move out of the way) holds anything under, is not named on disk. Per-entry targets cannot collide: `git mv -- Members/README` and `mv -- Members/Atlas` now run in order (scenario `overlap`).
- **N2: U2, U3 and U4 survived.** `test_a_spelling_that_is_a_link_is_named_and_not_entered` kills U2 (a link entered, probe P19) and U3 (no `a symlink`, P20). `test_a_name_head_holds_that_is_not_utf8_is_shown_replaced` kills U4 (P14).
- **N3: the "#364's state on any OS" example and the docstring at `:278-280`.** The example above now says Linux, and shows the macOS/Windows text beside it. The test that docstring belonged to is replaced by two: one for the states every disk answers alike, and one that asserts per disk (`test_an_untracked_members_directory_is_moved_entry_by_entry_on_linux`).
- **N4: "hold as one directory with it" for a FILE named `Members`.** The sentence is now "a path at or under another spelling of members/, which a case-insensitive disk takes for members/ itself", true of a file too.
- **N5: `folding_lexists` walked from `/`.** It is replaced by `disk_as`, which resolves names below the holder root only and passes every other path through unchanged.

Head `e5aac93f` adds one commit on `8a95345b`. It changes only `tests/test_family_members_case_variants.py` (+102); no product code changes. The re-review (rvcase2) said APPROVE WITH NITS: every point above is fixed, every scenario ends clean as typed, and five nits remain.

- **NIT-1: ten conditions no test caught.** rvcase2's probes Q1-Q7 and Q9-Q11 each left all 57 tests passing. Four new rows in the layout table, each asked of both disks, and one new unit test now guard them:
  - a link `Members` to a directory outside the holder, `members/` gone (Q1, the alias may be a link). A folding disk resolves `members` through the link, and it must still be named as a link. This is now caught on every OS by the emulated folding disk, not by macOS CI alone. The row skips on Windows, before the link is made.
  - three committed entries under `Members/` (Q2-Q5): a gitlink `X` with its directory on disk (`git mv`); a file `README` where the disk holds a directory (`git rm -r --cached`); and `docs/a`, kept off disk by `skip-worktree` (`git mv --sparse` of the entry itself). HEAD holds the removed entry, so the text says "and commit both".
  - a file at `Members/IRQS`, in the index and on disk (Q11): #318's index-only text must not take it.
  - a gitlink `Members` over a human's `Members/notes.txt` (Q10): on Linux, the file under that entry is the index's to name.
  - the move back of a renamed `members/` (Q6, Q7, Q9). This needs two spellings side by side, which only a disk that does not fold case can hold, and no test makes them. So `_disk_spellings` is asked of a listing handed in, with nothing read from a disk: the move back happens once only, never where `members/` is on disk, and never for a `.git` that no gitlink names.
- **rvcase2's twelve probes (`rvcase2/mut2.py`), re-run against these tests** with `-x`, the new file plus #318's three tests. Every probe now fails a test:

  | probe | result | the first test that fails |
  |---|---|---|
  | Q1 alias may be a link | `1 failed, 46 passed` | layout `a link Members, no members/-folding` |
  | Q2 on-disk kind ignored | `1 failed, 47 passed` | layout `and every remedy the index takes-linux` |
  | Q3 gitlink not asked for a directory | `1 failed, 47 passed` | the same row |
  | Q4 sparse entry keeps its group target | `1 failed, 47 passed` | the same row |
  | Q5 "commit both" wording | `1 failed, 47 passed` | the same row |
  | Q6 move back more than once | `1 failed, 53 passed` | `test_only_a_spelling_that_is_members_renamed_is_moved_back[once, though two spellings hold checkouts]` |
  | Q7 move back where `members/` is on disk | `1 failed, 54 passed` | `...[never where members/ is on disk]` |
  | Q8 move back without a `.git` | `1 failed, 39 passed` | layout `a human's own Members/, no members/-linux` |
  | Q9 move back without the gitlink | `1 failed, 55 passed` | `...[never for a .git no gitlink names]` |
  | Q10 a path under an index entry named | `1 failed, 51 passed` | layout `a gitlink Members over a human's Members/-linux` |
  | Q11 every mount variant taken as a directory | `1 failed, 49 passed` | layout `and a file Members/IRQS in the index and on disk-linux` |
  | Q12 no case for a bare `Members` | `1 failed, 4 passed` | `test_an_index_entry_with_nothing_on_disk_is_taken_out_of_the_index[Members-Members-true]` |

- **Tests at `e5aac93f`:** the new file (60 tests) and `tests/test_family_add_refusals.py` (65): `125 passed in 105.50s`.
- **NIT-5, this body:** P4's row now reads "7 of the 9 folding rows"; the #362 example says its text holds in a fresh clone; and the merge checks are refreshed.
- **NIT-2, NIT-3 and NIT-4** are checklist candidates below.

- **The new code is `family-members-dir-variant`**, used where every path found is under a spelling of `members/` alone. Codes about the holder as a whole start with `family-` (`family-index-locked`, `family-on-tracking-branch`, `family-members-unrecognised`). `members-dir` is `family.yaml`'s own name for that directory (`members_dir`). `variant` is the word #318's refusal and the validator use. `member-path-taken` stays wherever any path is a case variant of the mount path `members/<P>`, as #318 and #364 have it.
- **The alias is asked, never guessed.** `isdir` and `samefile` are what the disk says. On Linux `members` is simply not there when only `Members` is (Codex's state), and with two directories `samefile` is false. A Linux `members` symlink is listed as `members`, so it is never the alias. A Linux `casefold` directory answers as macOS does, which is right.
- **Per entry, not per file.** The remedy names the entry directly under the other spelling, so `Members/docs/` with 300 files is one `git mv`. A `git mv` of a directory is one `rename(2)`, so its untracked contents go with it, and a mount variant `Members/<P>` is cleared in one step on every disk. The full entry is used only where the name folds to something `members/` itself tracks.
- **"On disk" means in its own spelling (`_on_disk_as_named`).** It reads listings component by component, exactly. On macOS `lexists("Members")` is true because `members/` exists, and `git mv -- Members X` there would move `members/`. With exact listings an index file `Members` beside `members/` is taken out of the index instead, on every disk.
- **An empty directory under another spelling is not named.** `git mv` and `rm` of its last entry leave one behind on Linux; it holds nothing a clone or a disk could meet. A directory nobody may list is named and moved whole, since nobody can tell it is empty.
- **A `members/` renamed by hand is moved back (Linux).** The sign is a member's checkout in it: `<spelling>/<name>/.git`, with the gitlink `members/<name>` in the index, and no `members/` on disk. A human's own `Members/` holding a directory named like a member, with no checkout in it, is named entry by entry instead.
- **The commit after `git rm --cached` is printed only where there is one to make:** where HEAD holds the entry, or will once the pending change is committed. A staged-only entry, #362's own planted state, leaves nothing to commit, and a printed `git commit` would fail with `nothing to commit`.
- **`git mv --sparse` needs git 2.34 or later**, the release that made `git mv` and `git rm` refuse paths outside the sparse checkout. Its test skips on an older git.
- **#318's unit test** (`test_the_index_is_asked_at_the_mount_path_in_any_case_and_literally`) pinned "a variant of `members/` alone: not refused, by design". Its docstring cites Brett Heap's ruling of 2026-10-14 ("Refuse on every disk"). It asserts that `_members_spellings` names each entry with its target and remedy.
- **#318's end-to-end test of the unwind's closing sentence** runs in process with `_members_spellings` switched off, so the unwind's guard behind the refusal stays tested.
- **`add --dry-run` refuses alike**, because the check runs before the dry run branches off.

All runs used `run9.sh`: a `gh` stub first on PATH, `GH_TOKEN=bogus`, an empty `GH_CONFIG_DIR`, `/usr/bin/python3 -m pytest`, and `PYTHONDONTWRITEBYTECODE=1`.

- `tests/test_family_members_case_variants.py` held 49 tests at `8a95345b` (60 at `e5aac93f`; see Round 3). Run against `40eda849`'s `family.py`, with #318's unit test beside them: `40 failed, 10 passed in 60.95s`. The 10 that pass are behaviour round 1 already had right: the controls (2); HEAD's mount variant (2); `members/irqs` untracked (1 end-to-end, 2 in the layout table); the unlistable `members/` backstop; and the folding-disk answers for Codex's state and a human's own `Members/`, which round 1's rule (b) hid on every disk.
- At head `8a95345b`, the new file, `test_family_add_refusals.py`, `test_repo_hygiene.py` and `test_cli_reference.py`: `189 passed in 180.78s`.
- On the merge of `8a95345b` with origin/main `64fc9a86` (main has rewritten `test_family*.py`'s clone sites since this branch's base), the new file, `test_family_add_refusals.py`, `test_family_member_path.py`, `test_family.py`, `test_repo_hygiene.py` and `test_cli_reference.py`: `338 passed in 353.46s`.
- Round 1's two batches, on the bytes of `8a95345b` before a two-line docstring correction:
  - batch A plus `test_family_add_refusals.py`, 14 files (test_family_members_case_variants, test_family_add_refusals, test_family_member_path, test_family_add_excludes, test_family_member_name, test_family_add_member_id, test_family_dry_run, test_family_tracking_branch, test_family_printed_quoting, test_family_bump_remove_rollback, test_family_bump_to_a_tag, test_family_init_landing, test_refusal_default_remediation, test_template_text_placeholders): `561 passed in 862.50s`;
  - batch B, 9 files (test_family, test_validate_family_member_path_glob, test_validate_family_unnamed_mounts, test_validate_family_duplicates, test_validate_family_without_git, test_update_shape_pr_base, test_cli_reference, test_repo_hygiene, test_shape_doctor): `671 passed, 3 skipped in 1228.01s`. The 3 skips are the Windows-host PowerShell lines in test_shape_doctor.

What the tests cover, and how each stays portable across all three systems:

- **Every printed remedy is typed as printed** (`type_remedy`), and the same `add` then pins the member under `members/` alone, with a clean `git status`.
- **Index and HEAD states** are planted with `update-index --cacheinfo`, under `core.ignorecase` true and false. A non-UTF-8 name goes in through `--index-info` with bytes on stdin, and is committed by `write-tree` and `commit-tree`, which never look for it on disk.
- **Disk states** use a holder with no member yet, or the holder's own `members/` renamed in place. No test makes two directories whose names differ only in case.
- **Where the disk decides the answer**, the test either asks the disk it runs on (`disk_folds`, one probe directory) and asserts that disk's answer, or runs in process under `disk_as`, which emulates a folding disk and a Linux disk below the holder root. Both answers are then asserted on every OS.
- **Skips** come before any call that could fail: links on Windows; an unlistable directory on Windows, as root, or on a folding disk; `git mv --sparse` on git older than 2.34.
- **Windows text mode:** files are written with `write_bytes`, and git's stdin is fed bytes.

The review's states (`$Q/v110/rvcase/scen.sh`), rebuilt on a fresh kit (local bare remotes, a `gh` that exits 97, called 0 times). After each refusal, every printed command was typed as printed. Only `<new name>` was filled in: `renamed-N` for a `git mv` (committed, so it stays in the holder) and a path outside the holder for a `mv`. "Linux" is this host. "macOS/Windows" is the same layout judged in process with `isdir`, `samefile` and `lexists` folding case below the holder root.

| scenario | `40eda849` | `8a95345b` |
|---|---|---|
| `macsingle` (Linux) | `git mv -- Members renamed-1` moves Nova: ` D members/Nova`, `member-uninitialized` | `git mv -- Members/README`, commit, `mv -- Members members`: add exit 0, status clean, `family ok` |
| `macsingle` (macOS/Windows) | `git mv -- Members ...` (moves Nova there) | only `git mv -- Members/README <new name>`: Nova's checkout stays in `Members/` with its `.git`; the check then passes |
| `macleft` (Linux) | `mv -- Members ...` moves Nova: ` D members/Nova` | `mv -- Members/Atlas ...`, then `mv -- Members members`: exit 0, clean, `family ok` |
| `macleft` (macOS/Windows) | `mv -- Members ...` | `members/Atlas already exists`, as `linuxleft`; removing it passes the check |
| `linuxleft` | `already exists` | unchanged; removed as it says: exit 0, clean, `family ok` |
| `codex` | add exit 0, holder split (` D members/Nova`, `?? Members/`) | refused; `mv -- Members members`: exit 0, clean, `family ok` |
| `ruleb` | add exit 0, `?? Members/` left | refused; `mv -- Members/Nova ...` and `mv -- Members/README.md ...`: exit 0. ` D members/Nova` stays, because the scenario deleted Nova's checkout; `git submodule update --init` (the validator's own remedy) gives clean and `family ok` |
| `ruleb2` | `mv -- Members ...` | `mv -- Members/README.md ...`: exit 0; Nova as in `ruleb` |
| `idxonly` | `git mv` fails `bad source` | `git rm -r --cached -- Members/README` (nothing to commit): exit 0, clean, `family ok` |
| `sparsemv` | `git mv` fails `not under version control` | `git mv --sparse -- Members/README ...`, commit: exit 0, clean, `family ok` |
| `overlap` | second command fails `mv: cannot stat 'Members'` | `git mv -- Members/README`, commit, `mv -- Members/Atlas`: exit 0, clean, `family ok` |
| `r318` | 3 rounds; leaves `?? Members/Atlas/` | 1 round, `git mv -- Members/Atlas`, commit: exit 0, clean, `family ok`, HEAD holds `renamed-1/README` |
| `r318mac` (Linux) | ends moving Nova | `git mv -- Members/Atlas`, commit, `mv -- Members members`: exit 0, clean, `family ok` |
| `r318mac` (macOS/Windows) | `git rm --cached`, then `mv -- Members` | `git mv -- Members/Atlas`: Nova stays; the check passes |
| `linux362` | `git mv -- Members`: exit 0 | `git mv -- Members/README`, commit: exit 0, clean, `family ok` |
| `twodirs` | `mv -- Members ...` | `mv -- Members/Nova ...`: exit 0, clean, `family ok` |
| `mac-ok` (the control) | exit 0 | exit 0, clean, `family ok` |
| #363 (`i363`) | `git commit`, then exit 0 | `git commit`, the text now naming `Members/README.md` rather than `Members`: exit 0, clean, `family ok` |
| #364 (`i364`) | `mv -- Members ...` | `mv -- Members/Atlas ...`: exit 0, clean, `family ok` |

Every refused first `add` printed nothing on stdout. Not reproduced: a real macOS or Windows disk. The folding disk is emulated (`core.ignorecase`, and `isdir`, `samefile` and `lexists` resolved case-insensitively below the holder), and CI's macOS and Windows jobs run the tests on real disks.

Each probe changed one hunk of this round in a throwaway worktree, then ran the new file (49 tests) and #318's three tests in `test_family_add_refusals.py` (8 cases), 57 in all. At least one test failed every time:

| probe | what it undoes | result | a test that fails |
|---|---|---|---|
| P1 | per-entry targets (back to the spelling's directory) | 19 failed | `test_the_printed_git_mv_leaves_the_members_where_they_are` |
| P2 | the full entry under a name `members/` tracks | 2 failed | `test_an_index_entry_with_nothing_on_disk_is_taken_out_of_the_index[Members/irrs/a-...]` |
| P3 | an unlistable directory read as empty | 1 failed | `test_another_spelling_nobody_may_list_is_named_and_moved_whole` |
| P4 | the alias (`isdir` + `samefile`) | 8 failed | 7 of the 9 folding rows then in the layout table, and `test_the_printed_git_mv_leaves_the_members_where_they_are` |
| P5 | "on disk" by exact listings (back to `lexists`) | 1 failed | layout `a file Members in the index, beside members/-folding` |
| P6 | `git mv --sparse` for a skip-worktree entry | 1 failed | `test_an_entry_a_sparse_checkout_keeps_off_disk_takes_git_mv_sparse` |
| P7 | another spelling's directory named entry by entry | 13 failed | `test_a_tracked_path_on_disk_takes_one_committed_git_mv[Members/README]` |
| P8 | an empty directory not named | 6 failed | `test_a_tracked_file_deleted_from_disk_is_taken_out_and_committed` |
| P9 | the move back of a renamed `members/` | 6 failed | `test_a_members_directory_renamed_by_hand_is_moved_back` |
| P10 | the alias's own entries judged as `members/`'s | 6 failed | layout `members/ renamed Members (Codex's P2)-folding` |
| P11 | never renaming the alias itself | 1 failed | layout `and a gitlink named Members in the index-folding` |
| P12 | the move back kept when the index holds things under it | 2 failed | layout `and Members/README in the index (#362, B1)-linux` |
| P13 | a disk path dropped when the index holds things under it | 3 failed | `test_a_tracked_path_on_disk_takes_one_committed_git_mv[Members/docs/notes]` |
| P14 | U4: a HEAD-only name shown with U+FFFD | 1 failed | `test_a_name_head_holds_that_is_not_utf8_is_shown_replaced` |
| P15 | no commit printed after removing a staged-only entry | 12 failed | `test_an_index_entry_with_nothing_on_disk_is_taken_out_of_the_index[...]` |
| P16 | the commit after a removal once the pending change is committed | 1 failed | `test_every_place_is_named_and_the_pending_change_is_committed_first` |
| P17 | `already exists` in the alias only where the index holds no variant | 1 failed | layout `and Members/IRQS/README in the index (#318)-folding` |
| P18 | #318's text only for variants with nothing on disk (S3) | 3 failed | `test_a_tracked_path_on_disk_takes_one_committed_git_mv[Members/IRQS/README]` |
| P19 | U2: a link not entered | 1 failed | `test_a_spelling_that_is_a_link_is_named_and_not_entered` |
| P20 | U3: `a symlink` named | 1 failed | `test_a_spelling_that_is_a_link_is_named_and_not_entered` |
| P21 | N4's wording | 29 failed | every refusal naming `family-members-dir-variant` |

The other hunks are docstrings, which change no behaviour.

`git merge-tree --write-tree 8a95345 <ref>`, after a fetch at round 3. Every result is clean. Round 3's commit changes only `tests/test_family_members_case_variants.py`, which no ref below touches.

- origin/main `f5fc7056166d` (round 2 checked 64fc9a8 and 7d9bec9, both clean): clean. Since 64fc9a8, main has not changed `tests/test_family.py`, `tests/conftest.py`, `tests/test_family_add_refusals.py` or any script these tests load, so round 2's run on the merge with 64fc9a8 still holds for them. #561 has landed, so it is no longer checked as a PR head.
- #568 `fix/family-bump-to-checks` `8024f9c914fd`: clean.
- #571 `fix/family-remove-gitmodules-missing` `ebe6b512db02`: clean.
- #576 `fix/link-source-chain-defaults` `a707d4ba3f54`: clean.
- #578 `fix/family-siblings-tracking-branch` `0112dcb63391`: clean.
- Lane 2's `fix/537-dry-run-asks-remotes` `69c58aae2a04` and `fix/539-validators-lockstep-remedies` `0680799c7b21`: clean.

The tests on the merge with origin/main are in the Tests section.

- **#363 option 2, a check of the commit after the fact** (`git ls-tree HEAD` must hold the gitlink at exactly `members/<P>`, else undo). The ruling refuses before the mount, so nothing here needs it. It would still catch a cause nobody has foreseen.
- **#363 item 3, the validator option:** `validate-family.py` would say that a gitlink in HEAD at a case variant of a row's path is why the gitlink is absent. That is a pinned template file, and lane 2's #539 is editing its remedies.
- **Docs.** `git grep` of AGENTS.md, README.md, `docs/handbook.html` and `templates/family-root/` (README, AGENTS.md, AGENTS-shape.md) found no sentence about `add`'s refusals or about `members/` versus `Members/`, so none became false. AGENTS.md is at its 490-line cap. `templates/family-root/AGENTS-shape.md` is digest-pinned into every holder.
- **`docs/release-notes/v1.0.0.md`** lists #362, #363 and #364 as v1.0.0's known limits. That is still true of v1.0.0, so the file is untouched.
- **Contrived states, not handled:** a gitlink named `Members` in a Linux holder whose `members/` was also renamed `Members`; Windows' trailing-dot and 8.3 aliases of `members`; NFD names. The case-folding is ASCII, as git's `icase` is, and project names are ASCII.

- **`family.py add`: check the commit after the fact (#363 option 2).** After `_commit_one`, read `git ls-tree HEAD` for a gitlink at exactly `members/<P>`. If it is anywhere else, undo this command's commit and the mount, and refuse with the spelling git chose. This catches any cause of a misplaced gitlink, not only the case variants refused here.
- **`validate-family.py`: say a HEAD gitlink is at a case variant of the row's path (#363 item 3).** A holder already pushed in #363's state is told `member-gitlink-absent` in a fresh clone, with nothing about the `Members/<P>` that HEAD holds. Reading HEAD's gitlinks folded for case would name the cause.
- **`validate-family.py`: the `member-gitlink-unnamed` remedy for a hand mount under `Members/`.** The remedy says `git rm` the gitlink, then `family.py add` it. Under a spelling of `members/` other than `members/`, `add` now refuses until that `git rm` is committed, and says so. The validator's sentence could say "commit the removal" before the `add`. Lane 2's #539 is editing these remedies.
- **Docs: name the one-spelling rule for `members/`.** AGENTS.md's family section, the README's family section and the holder's `AGENTS-shape.md` could say that a holder keeps `members/` in one spelling, and that `add` refuses `family-members-dir-variant` until a human renames their `Members/`. AGENTS.md is at its line cap.
- **`family.py add`: a file named `members`, or a sparse checkout that leaves `members/` out, is refused late** (rvcase's `mfile` and `sparse`). Both pass the checks, the member is read and mounted, and `git submodule add` then fails; the unwind restores the holder. Both could be refused up front, the second naming `git sparse-checkout add members`.

- **`family.py add`: a member's own gitlink renamed with `git mv members Members` (NIT-2).** Staged or committed, the gitlink sits at `Members/<M>`, and the refusal names it with the generic `git mv -- Members/<M> <new name>`. Typed with any name, the add then passes and the validator says `member-gitlink-absent`. The right name (`members/<M>`) fails as typed until `mkdir members` (`$Q/v110/rvcase2/scen-gitmv.log`, `stagedmv`, `committedmv`). The holder's own validator already refuses that state before the add. A refusal that named a gitlink `<spelling>/<M>` whose `members/<M>` is a `members:` row could print `mkdir members` and the move back.
- **`family.py add`: a macOS or Windows holder that PULLED a commit adding `Members/README` (NIT-3).** There the directory stays spelled `members` and the file lands at `members/README`. Since exact listings do not find `Members/README`, the remedy is `git rm -r --cached`, not the ruling's committed `git mv`, and the file is left untracked at `members/README` (`$Q/v110/rvcase2/scen-head.log`, `macpulled-mac`, emulated). It is benign: committing that file afterwards still gives `family ok`. Folding the lookup for targets below the spelling, keeping the exact rule only for a bare `Members`, would print the `git mv` there too.
- **`git mv --sparse` needs git 2.34 or later (NIT-4).** The estate states no minimum git (`README.md:215`, `README.md:365`, `docs/handbook.html:617`), and `scripts/shape_materialize.py` keeps a fallback for git older than 2.32. On such a git the sparse remedy fails with an unknown option; nothing is damaged (`$Q/v110/rvcase2-report.md`, NIT-4). The text could say "git 2.34 or later", or fall back to `git rm -r --cached` there.

Review: rvcase found 1 blocker, 3 should and 5 nits on 40eda84, and Codex a P2; fix round 8a95345 fixed them all; re-review rvcase2 found 5 nits, fixed in round 3 (e5aac93, tests only), and Codex's `:2099` thread is answered. CI (Brett Heap's ruling 27): H0 e5aac93 passed tests, tests-macos, tests-windows and SonarCloud; the head 4c21ce2 is a clean update-branch merge of main 40b476d, with tests and SonarCloud green, and the local gate passed on its predicted squash (the family, validate-family and hygiene sets: 1050 passed, 19 skipped, over 66267f0). Landed on Brett Heap's word of 2026-10-15T13:32:47Z, "All five, once green".

Closes #362
Closes #363
Closes #364

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
brettheap pushed a commit that referenced this pull request Oct 15, 2026
…n-source-unread

Merges origin/main 66267f0 so the PR's CI merge ref and the fix that follows
run on current main. The fourteen landings since 2bf8fd4: #597, #578, #593,
#589 (#449), #586, #573 (#537), #575 (#539), #566 (#528), #571, #588, #569
(#538), #582 (#523), #616 and #576 (#441, #442).

Those that touch this PR's files:
- adopt-project.py: #589 (`check` recomputes each pin's digest in the clone
  `plan` read it from: LOCAL_CLONE_RE, _recorded_clone, _why_not_rechecked,
  _recomputed_pin_finding, _pin_digest_findings), #582 (what `plan`,
  `execute` and AGENTS.md say around a run) and #566 (a source's own
  `single-repository.yaml`).
- scaffold-project.py and docs/cli.md: #573, #569 and #576 (the
  `_declaration` docstring: `--pin-source` verifies the first chain link
  alone, which this PR's N3 wording already says).
- tests/test_adopt_pins.py: #589's thirteen cases.
- tests/test_scaffold_leg_path_collisions.py: #573.

This commit holds the textual resolution only. One hunk conflicted, the
`from shape_materialize import (...)` list at adopt-project.py:261. It is
resolved as the union of both sides' changes to the list: main's added
`pin_digest_from_source` (#589), and this PR's added `DIGEST_FROM_CLONE`,
`DIGEST_FROM_GH`, `pin_source_path` and `refuse_an_unread_pin_source` and
its removal of `one_printable_line`, whose last caller this PR deleted and
to which main added none (keeping it is pyflakes' "imported but unused").
pyflakes adopt-project.py is clean on the merge. Every other file merged
without a marker, and `scripts/render-cli-reference.py --check` is ok.

The merge alone does not keep #589 working: this PR's `plan` records a bare
`local-clone`, which names no clone for #589's `check` to read, and `check`
refuses `local-clone (<path>)` as `plan-pin-malformed`. The next commit
reconciles the two.

Lane: openreposhape-2 (openRepoShape-2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
brettheap added a commit that referenced this pull request Oct 15, 2026
…ing clones from a holder in a folder named after its repository, and that from anywhere else it clones nothing and prints the mv, as it does since #578 (#605) (#624)

Since #578 (3f768a6), `make siblings` asks about the holder's parent folder before it looks at any member: from a holder whose parent folder is not named after the holder's repository, nor reached through a link of that name beside it, it clones nothing, prints the exact `mv` and exits 1. Two sentences the doctor's `members` row printed about it were true only before that.

- The green note on a member with no working clone said "`make siblings` places them". It now says when: "`make siblings` places them when the holder is in a folder named after its repository, or in one a link of that name beside it leads to; with the holder anywhere else it clones nothing and prints the `mv` that moves it into such a folder; the pinned copy under members/ is detached by design".
- The stranger note, on a clone of another repository beside the holder, said "`make siblings` calls the same directory WRONG ORIGIN and leaves it exactly as it is". It now says "`make siblings`, from a holder in a folder named after its repository, calls the same directory WRONG ORIGIN and leaves it exactly as it is".

The folder is named after the holder's repository (`repository:`'s basename, as `siblings.py::family_folder_name` has it), not the family's display `name:`, and the link counts only beside the holder's parent folder (`family_link`). The words are static: the rule lives in the holder's pinned `scripts/siblings.py` and a copy in the doctor would drift, so the row names the command and its condition and `make siblings` prints the `mv` itself. Two tests assert both notes byte for byte, the green one for a holder in a folder named after its repository and for one in any other folder; restoring the old words, "the family", or dropping "beside it" fails them.

Closes #605

Lane: openreposhape-4 (openRepoShape-4)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
brettheap added a commit that referenced this pull request Oct 16, 2026
…resume` print the family's name and every member row spelled and never end in a traceback on `name: "a\ud83db"` or a dash under `PYTHONIOENCODING=ascii`, and the holder's README names its folder after the repository, so `--family Quill --name QuillWorks` lays out as its README says (#454, #629) (#642)

#454. `templates/family-root/scripts/siblings.py` opened each of its two reports with a plain `print` of `family.yaml`'s `name:` (`_run_placement` for `make siblings`, `dispatch_all` for `--make <target>`, which `make park` and `make resume` call) and printed every member row raw. On origin/main 8f453d0:

- `name: "a\ud83db"` is a string holding a lone surrogate, which no UTF-8 stdout can write: `siblings.py --dry-run` ended in `UnicodeEncodeError` at the first line (exit 1), `make siblings`, `make park` and `make resume` exited 2, and `make park`, which exists to save work, parked nothing.
- The line holds a literal dash, so under `PYTHONIOENCODING=ascii` it raised for EVERY name, `InkRouter` included.
- A raw ESC or CR in a value reached the terminal as the control it is.

#391 gave both roots' `bootstrap.py` `escape_unencodable_stdout()` and `spelled()`, written once in `scripts/repo_shape.py`. `siblings.py` now does the same in the same way:

- both names join the `from repo_shape import` line it already has, and it defines neither;
- `escape_unencodable_stdout()` is the first statement of `main`;
- `spelled` is applied to every value a line prints that a manifest, a member row or a disk gave: the name and the root (both headers), the folder and the link, a member's project, path, url and the reason its tracking branch is not known, the `Sibling.row` project and branch, the `FINDING` lines' project, directory, `origin` and `--make-arg`s, and the member's own `[project]` and `---` header lines. The member's own `make` is still handed the RAW target, the `mv` lines a person pastes stay quoted and unspelled (an escape in a command would not run as typed), and git's own words are left as git wrote them.

A plain name prints exactly what it printed before: the tests spell out the whole output of both runs for a plain holder, and that golden passes on the base too.

#629. `family.py init --family Quill --name QuillWorks` wrote a holder whose README said `cd QuillWorks` and laid the folders out as `QuillWorks/QuillWorks`, with "the doubled `QuillWorks/QuillWorks` is deliberate". `siblings.py`'s `family_folder_name` names the folder after the REPOSITORY (the basename of `repository:`, `Quill`), so a holder laid out exactly as its README said got `WARNING the holder's parent folder is 'QuillWorks', not 'Quill'`, cloned nothing, and `make` exited 2. No test built a holder whose `name:` differed from its repository and ran `make siblings`.

- `templates/family-root/README.md` names the folder with `{{FAMILY}}`, the placeholder `family.py init` already fills with `--family` (the same string `family_folder_name` reads out of `repository:`): the `cd`, the two layout lines and the sentence about the doubled name. `{{FAMILY_NAME}}` is left only as the README's title. A sentence says both are named after the REPOSITORY and that the display name names no folder. No new placeholder, and `scripts/family.py` is untouched.
- `templates/family-root/AGENTS.md` is unchanged: its two uses of `{{FAMILY_NAME}}` (`the family holder **X**`, `X's own`) are titles and name no folder, which the issue's list had as lines 3 and 7.
- `siblings.py` says which name it means. Where `name:` and the repository's name differ, the placement header gets one line under the folder's own, on a stopped run and a passing one alike: `the folder is named after the holder's REPOSITORY, Quill, and never after name: QuillWorks, which is only a display name`. Where they are one string nothing is added. The module docstring says which name `<Family>` is. `--make` asks nothing of the folder and keeps its header.
- `family_folder_name` and the README now agree, and a test holds them to it.

**Pinned shape copies.** `templates/family-root/scripts/siblings.py` is in `FAMILY_COPIED_VERBATIM` and digest-pinned in every holder: a holder that re-syncs reads `upstream-changed` for it, and a holder pinned since #456 gets that one row alone, since its `scripts/repo_shape.py` already defines both names (no digest of either is recorded in this repository: the files: rows are computed from the bytes each tool writes, as for #391 and #578). `templates/family-root/README.md` is TEMPLATED, not pinned: an existing holder keeps its own README, and only a holder made after this has the corrected one. `scripts/repo_shape.py` is not changed. A holder that keeps its own edit of `repo_shape.py` without the two names `siblings.py` now imports is refused by `apply` as `update-accept-local-missing-name` (#536), which already lists `siblings.py` as an importer.

**Files.**

- `templates/family-root/scripts/siblings.py`
- `templates/family-root/README.md`
- `tests/test_siblings_family_name.py` (new)

`docs/cli.md` is unchanged: no `--help` text moved, and `AGENTS.md`, `README.md` and `docs/handbook.html` say nothing this makes false ("named after the family" is `--family`'s name, as before).

Closes #454
Closes #629

Lane: openreposhape-4 (openRepoShape-4)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This was referenced Oct 16, 2026
brettheap pushed a commit that referenced this pull request Oct 17, 2026
#813 and #723, v1.0.0's quoted-header and plain-path-clone limits closed and the counts current to main bad05d2 (#563)

Each entry is the one RV630 corrected in its pre-review of the B2 stage,
put at its anchor, and checked against its squash on main: the
`git merge-tree --write-tree` of main before the squash with the head the
entry was written from equals the squash's tree for all seven.

- #810 (#674, `d17564d9`): a new bullet, "`apply`'s lines, its branch and
  its headers.", after "Headers, branches and messages.". It closes
  v1.0.0's quoted `files:`/`shape:` header (v1.0.0.md:439) and `apply`'s
  half of the paths listed as staged (:433); `bump-leg.py`'s half waits
  for #746.
- #731 (#692, `d66a9054`): appended to "Folders, asked before they are
  made.".
- #813 (#689, `f6d17bc5`): appended to "`--tracking-branch`.".
- #809 (#688, `42aed788`): a new bullet, "What `family.py init` records
  and commits as.", after "Names that are not UTF-8.".
- #816 (part of #684, `fa04d2cd`): a new bullet, "More holder states,
  named.", after "family.py refuses before it writes.". #816 closes no
  issue; #684 keeps its reftable case and is on v1.1.1.
- #748 (#662, `431c8cf8`), then #723 (#663, `bad05d21`): in the CI
  bullet, after #713's sentence. With #554 and #578, #748 closes v1.0.0's
  limit on fixtures that clone a just-pushed remote by plain path (:530).

The counts, in the header comment, the counts paragraph, "What changed"
and the open list: main `bad05d2`; 120 pull requests since `bfed143`;
at 18:02Z, 3 of the `v1.1.0` milestone's 133 issues open and 130 closed.
The open list is #563 (#630), #672 (#746) and #686 (#795); #684 and #695
(#738) are on v1.1.1. #746 and #795 have not landed, so neither has an
entry yet. Nothing since 2000488 touches pyproject.toml,
src/openreposhape/, install.sh or .github/workflows/.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
brettheap added a commit that referenced this pull request Oct 17, 2026
… `--into` sentence names the `family-landing-in-standard` refusal, `make siblings` is described as it stops before cloning, and `members/` has its one-spelling rule (#695) (#738)

The family docs now say what `family.py init`, `make siblings` and the `members/` directory do since #488, #578 and #574. Base: `8062810d`. Head: `c42286de`: the work (`73fa3ff4`) and one commit for the review's nit on L20.

**The branch now holds `origin/main` at `24a977c0`, through one merge commit, `75e35f14`.** No other commit was added, and nothing was rebased or amended.

### What failed

Since #682 landed (`dc7d3fbb`), `git merge-tree --write-tree HEAD origin/main` against `c42286de` stopped on one line of `docs/handbook.html`:

    Auto-merging docs/handbook.html
    CONFLICT (content): Merge conflict in docs/handbook.html

It is the `families` section's marker, `<!-- reads README.md § Families: ... blob <hash> -->`. #682 changed a sentence of README § Families, so main's marker is `b3d19092...`. This PR changed other sentences of the same section, so its marker is `0364c579...`. Git saw one line changed two ways. Lane 2's note on #738 (2026-10-17T12:47:17Z) named the same line. I reproduced the conflict on the head I started from, then merged by hand.

### The fix

The merged README § Families is neither side's text, so the marker takes its fingerprint, `82d7f8087b9ee4d097d33e15fbfe5ae754a04a79`. I computed it with `tests/test_repo_hygiene.py`'s own `readme_fingerprint` over the merged `README.md`. It is the value lane 2's note gave, and it did not move when main moved on to `24a977c0`.

| marker value | where it came from | handbook outline test |
|---|---|---|
| `b3d19092...` | main's side | fails: "has moved since the page read it" |
| `0364c579...` | this PR's side | fails, same message |
| `82d7f808...` | the merged README § Families | passes |

I re-read both sides before taking the value:

- Main's side brought one sentence into README § Families (line 955, "`make bootstrap` reports and skips one it lacks a credential for."), and #682 had already put the matching sentence on the page.
- This PR's side is its own 55 README lines and 27 handbook lines in that section, which merged clean.
- Both sides' sentences stand in the merged README and in the page.

### Did the merge change README or handbook text beyond the conflict line?

No. I compared each changed file's diff against the parent that did not make it:

- `README.md`: the merge against `origin/main` shows exactly this PR's own change, and the merge against `c42286de` shows exactly main's own change since `8062810d` (one line, #682's). No line differs.
- `AGENTS.md`: the same two comparisons, no line differs.
- `docs/handbook.html`: the same two comparisons differ in the marker line only, in both directions.
- README's handbook markers (23 on the page) and README's line cap are untouched. `tests/test_repo_hygiene.py` passes with the cap and the markers as they are.

This PR still lands only in lane 3's README turn. If another README PR changes § Families first, the marker moves again, and the hygiene test names it.

### Tests

All on `75e35f14`, through the gh stub, with a bogus token and an empty `GH_CONFIG_DIR`.

| run | files | result |
|---|---|---|
| core | `test_readme_sections.py`, `test_family_docs_one_spelling.py` (the one test file this PR changes), `test_repo_hygiene.py`, `test_agents_md_codes.py`, `test_cli_reference.py` | 240 passed |
| handbook readers | `test_readme_windows_quoting_sentence.py`, `test_setup_by_hand_commands.py`, `test_update_add_codes_documented.py` | 20 passed |
| family-root templates | `test_pinned_copy_text.py`, `test_template_values_single_pass.py`, `test_family_init_values.py`, `test_family_init_landing.py`, `test_siblings_family_name.py`, `test_family_makefile_siblings.py`, `test_family_siblings_placement.py` | 582 passed, 19 skipped |
| bootstrap (main's new files, over the template this PR reworded) | `test_bootstrap_spelling.py`, `test_bootstrap_without_git.py`, `test_bootstrap_leg_moves.py` | 251 passed |

### Mutants

This round adds no test and no code, so its one hunk is the marker value. Each mutant changes that value in a shared scratch clone at `75e35f14` and runs `tests/test_repo_hygiene.py::test_the_handbook_follows_the_readmes_outline`:

| mutant | result |
|---|---|
| none (control) | 1 passed |
| main's marker `b3d19092...` | 1 failed |
| this PR's marker `0364c579...` | 1 failed |
| the right marker with its last digit changed | 1 failed |
| the unresolved conflict block (`<<<<<<<`, both lines, `>>>>>>>`) | 1 failed |

### Merge checks

- `git merge-tree --write-tree HEAD origin/main` is clean at `24a977c0`.
- Main moved to `40e678e6` (#805, `templates/family-root/scripts/siblings.py` and `tests/test_siblings_inputs.py`) after this merge. It touches no README, handbook or AGENTS text, and the merge-tree against it is clean.
- Lane 2's #822 is stacked on this PR. Its reviewer found it merges clean with this PR landed at the same marker value.

1. **The `--into` sentence** (README.md § Families and the handbook). It gave the default, "the directory you are standing in", and not that `init` refuses that default inside a checkout of this standard. It now says so and names the code: `(the directory you are standing in, by default; refused inside a checkout of this standard, \`family-landing-in-standard\`)`. AGENTS.md already said it.
2. **The `make siblings` paragraph** (README.md § Families and the handbook). It said `make siblings` "WARNS and prints the exact `mv`". Since #578 it also clones nothing until the `mv` is run, so the next run clones each member once, and a link of the family's name beside the folder passes. It now says that. Lane 3's two #460 sentences ride in it (L20, L21, which lane 3 marked `-> #695`):
   - the folder must be named EXACTLY after its repository, case included, on every disk;
   - for a holder at `~/projects/InkRouter` the move makes the family folder `~/InkRouter`, beside `~/projects`, and the holder `~/InkRouter/InkRouter`, not `~/projects/InkRouter/InkRouter`.
   I wrote L20 with the paths spelled out. Lane 3's wording was "beside that folder's parent", which two readings can take. My first wording, "beside that folder, not inside it", still left one: the thing beside `~/projects` is the family folder, not the holder (rv695 N1). The printed move for that holder is `mv ~/projects/InkRouter ~/InkRouter.holder`, `mkdir -p ~/InkRouter`, `mv ~/InkRouter.holder ~/InkRouter/InkRouter` (probe below, and `test_family_siblings_placement.py` pins it).
3. **The one-spelling rule for `members/`.** One sentence, the same words in five places: AGENTS.md (family item 2), README.md § Families, the handbook, the holder's README and the holder's `AGENTS-shape.md`:
   > A holder keeps `members/` in ONE spelling on every disk: `add` refuses `family-members-dir-variant` (`member-path-taken` for a variant of the member's own path) until a human renames what sits under another spelling.

`templates/family-root/AGENTS-shape.md` changes by that one sentence. It is in `FAMILY_COPIED_VERBATIM`, so every holder reads `upstream-changed` for it on its next `update-shape.py check`. The issue's third line names it, and lane 3 asked that it ride with the next pinned-file edit. It can share the one v1.1.0 shape bump with the bootstrap fix. `templates/family-root/README.md` is templated and not pinned: an existing holder keeps its own README.

- README.md is 1458 lines, one under its cap of 1459 (1422 + 5 + 22 + 10 in `tests/readme-cap.d/`); it was 1459 at `73fa3ff4`. The brief said 1449; that is the cap before #627 landed. AGENTS.md is 492, its cap.
- The new words come to about nine README lines and three AGENTS.md lines. I fitted them by cutting wording that is stated elsewhere. **If you would rather keep the cut sentences, the alternative is a `tests/readme-cap.d/695.txt` of about +8, which needs Brett's word.** What I cut:
  - README § Families:
    - the aside "the same lands-where-you-were-standing rule projects have";
    - four rewordings that lose no meaning:
      - the intro of "Use a family when the parts deploy separately": "folding them into one assembly root would give them one gate, one release and one pin, which is the opposite of what 'deploy separately' means" is now "one assembly root would give them one gate, one release and one pin, the opposite of 'deploy separately'";
      - "`--work-dir` remains the override" is now "`--work-dir` is the override";
      - "The doubled name is kept on purpose" is now "The doubled name is on purpose";
      - "`family.yaml` is what tells the two apart" is now "`family.yaml` tells the two apart";
    - the caption "Eight services, each its own project, one holder:" under "The InkRouter example" (the section's intro and the block under it say it; this is the one line cut to make room for the L20 rewording, and the handbook keeps its caption);
    - the tool's rationale after "Nothing ever moves a checkout" (the shell, the editor, the agent lanes, "an act by surprise"); it stays in the handbook, the holder's README and the tool's own output, and README keeps the reason that matters (a linked worktree's `.git` file carries an absolute path);
    - ", not merely a repository at the right commit";
    - the private-legs reason in the `make bootstrap` paragraph;
    - "to a policy two live projects already carry a copy of" in the naming paragraph.
  - AGENTS.md:
    - the converse in the family intro ("one project is what parts that ship together already are"; README keeps it);
    - the sentence "`bump` takes the same repeatable `--trailer`" in family item 3 (stated in "Advancing a leg" step 6 and in the holder's `AGENTS-shape.md`);
    - "Do not pass `--yes` on your own initiative" in "Updating" step 2, now "Never pass `--yes` yourself", the words `test_repo_hygiene.py` requires elsewhere in the file.
- The handbook marker for README § Families is recomputed with `readme_segments` / `readme_fingerprint`: `89ef0ab5ec88...` to `0364c5794c46...` (it was `dc85a9260a67...` at `73fa3ff4`, before the L20 rewording and the caption cut). No other README section changed, so no other marker moves.

New file `tests/test_family_docs_one_spelling.py`, 17 tests: the one-spelling sentence in each of the five docs, the two codes held as strings by `scripts/family.py`, and the `--into`, `make siblings`, "named EXACTLY" and "straight in a folder" sentences in README and the handbook, plus the old "WARNS and prints" sentence gone from both. The handbook is read as the text a browser shows (`<code>` as backticks).

- On base `8062810d` (the file copied in): **15 failed, 2 passed**. The two that pass are the code-exists checks.
- On the head `c42286de`, after the L20 rewording: `test_repo_hygiene.py`, `test_readme_sections.py`, `test_agents_md_codes.py` and the new file: **217 passed** in 3.37s. The new file's `STRAIGHT_IN_A_FOLDER` is in the new README and not in the old one.
- Before that, the targeted runs, each at `8062810d` plus the working tree that was then the head (`73fa3ff4`):
  - `test_repo_hygiene.py`, `test_readme_sections.py`, `test_agents_md_codes.py`, `test_cli_reference.py`, `test_readme_windows_quoting_sentence.py`, `test_setup_by_hand_commands.py`, `test_update_add_codes_documented.py` and the new file: **253 passed**.
  - Fifteen files that read AGENTS.md, the holder's docs or the refusals (`test_family_init_landing`, `test_siblings_family_name`, `test_family_switch_branch_exists`, `test_family_tracking_branch`, `test_template_text_placeholders`, `test_template_values_single_pass`, `test_template_quoted_values`, `test_free_plan_hint`, `test_doctor_recorded_answers`, `test_update_shape_add`, `test_update_shape_header_comments`, `test_family_add_refusals`, `test_family_members_case_variants`, `test_family_member_path`, `test_doctor_legs_members_next`): **987 passed**.
  - Eight files: `test_adopt_plan`, `test_adopt_github_exits`, `test_adopt_late_failure`, `test_setup_project_py`, `test_family`, `test_family_siblings_placement`, `test_family_makefile_siblings`, `test_park_resume_targets`: **598 passed, 1 skipped** (`SHAPE_MEDXEHR_CLONE` unset: a plan test needs a read-only clone of MedxSoft/MedxEHR, a cloud tool).
  - `test_update_shape.py -k "shape_line or stale_readme or check_says_what_apply or readme_with_no_shape"`: 7 passed (the tests that read the holder README's last line). The rest of `test_update_shape.py` and `test_shape_doctor.py` were not run: they copy the family-root tree and match none of the lines I changed (`git grep` of the changed sentences under `tests/` finds nothing), and a first run of them crawled under a load of 90-100 on the machine.
- The full suite was not run, as the brief says.

- Row 1, on base: from a checkout of the standard, `python3 scripts/family.py init --org Acme --family Orbit --dry-run` ends `REFUSED family-landing-in-standard ... Remediation: pass \`--into ..\``. The README sentence did not say it would; it now does.
- Row 2, on head: `parent_folder_warning` of the holder's `siblings.py` for a holder at `<t>/home/projects/InkRouter` prints `NOTHING WAS CLONED` and the move `mv .../projects/InkRouter .../InkRouter.holder`, `mkdir -p .../InkRouter`, `mv .../InkRouter.holder .../InkRouter/InkRouter`. For a folder named `inkrouter` on Linux it stops the same way: the name test is exact on every disk.
- Row 3: the refusals the sentence names are the ones `test_family_members_case_variants.py` and `test_family_add_refusals.py` drive (60 + 65 tests, passed above).
- No row needs real GitHub or a cloud tool.

My own run did not happen: a usage checkpoint stopped it before it began. The reviewer (rv695) ran 30 mutants against `73fa3ff4` in a throwaway clone and **all 30 were killed**: five places, four mutants each for the one-spelling sentence, and five each for the README and the handbook sentences. The L20 sentence has changed since, and `STRAIGHT_IN_A_FOLDER` with it; no mutant was run on the new words. What the guards cover there: the sentence has a parametrized case per doc, so reverting it fails that case, and a reverted README hunk leaves the handbook marker stale.

- origin/main `55c6ba7d` (it moved past `2fac9790` by #700): clean. rv695 found `73fa3ff4` clean against `2fac9790`.
- #630 (lane 3), head `6fd33a93`: clean. It merged main `de926142`, and its handbook conflicts at the three markers are gone. On the merged tree README.md is 1472 lines and AGENTS.md 494 (counted here; rv695 found them under #630's own ledger at `73fa3ff4`).
- #682 (lane 5), head `8b39cd19`: conflicts at one line, the handbook marker for README § Families (`0364c5794c46...` here, `c40baa828dca...` there). README.md and the rest of the handbook merge clean, and the merged paragraph reads correctly, because both PRs change that section. Whichever lands second recomputes the marker from the merged README: on this head plus #682 the recomputed value is `da54c8ec2665...` (computed with `readme_fingerprint`, not test-run).
- I dropped the earlier list of clean PRs: it was taken against older heads, and several of them have landed.

(Brett Heap, 2026-10-16T13:36:23Z, on #459 line 141: "document it in the v1.1.0 release notes". `docs/release-notes/v1.1.0.md` exists only on #630, so this PR does not create it.)

> A holder made with `--family X --name Y` before #642 (the fix for #629) keeps `cd Y` in its own README, and `update-shape.py apply` never re-renders a README, so change that one line by hand to `cd X`: the holder's directory is named after its repository, `X`, never after the display name.

Such a README also shows `Y` in its layout block and its doubled-name sentence, as prose; only the `cd` line fails when run.

- The holder's README does not get lane 3's L20 and L21: lane 3 asked for them in the README paragraph, and the holder's README already names the folder after the repository.
- Checklist candidate, not for this PR (rv695 N6): the holder's own docs say the folder is "named after the family" (`templates/family-root/README.md:73`, `templates/family-root/AGENTS-shape.md:99`) and not "EXACTLY, case included", which the standard's README and handbook now say and `siblings.py` tests (`folder.name == family`). Lane 3 asked for L21 only in the standard's README paragraph, so it is not owed here; it could ride in the same re-pin.

Review: lane 5's independent review approved c42286d with its nits fixed; 75e35f1 is its update onto main (lane 2's note, issuecomment-6234057822); Codex found no major issues. CI (Brett Heap's ruling 27): H0 is the head 0b26ace itself, which passed tests, tests-git-bash and SonarCloud; main has touched none of its files since its base 2e476a7; and the local gate passed on its predicted squash tree 68dd413 over main 112eeed: the family_docs_one_spelling, readme_sections, readme_windows_quoting_sentence, setup_by_hand_commands, update_add_codes_documented, family_tracking_branch, family_switch_branch_exists, pinned_copy_text, repo_hygiene, agents_md_codes, cli_reference, family sets, 527 passed. Landed on Brett Heap's word of 2026-10-17T21:47:28Z, in lane 5's session (posted on #473 as issuecomment-6241758069): "merge lane 5's v1.1.1 PRs once reviewed and green".

Closes #695

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant