Skip to content

The boot and service scripts' comments are shorter, with their reasons kept - #241

Merged
DevomB merged 1 commit into
mainfrom
comments-build-scripts
Oct 7, 2026
Merged

DevomB merged 1 commit into
mainfrom
comments-build-scripts

Conversation

@DevomB

@DevomB DevomB commented Oct 7, 2026

Copy link
Copy Markdown
Owner

cleanup-held (65a6fbb) cut the comments of 57 files on 2026-10-05; 37 of them conflict with main now. This PR redoes its part for build/recipes/services.sh and five service scripts (boot-success.sh, installer-run.sh, sysinit.sh, testctl.sh, time-floor.sh) by hand on main, comments only. The other held files come in further small PRs, by directory. Files that an open PR touches wait until it lands.

How it was done. Each file was three-way merged from cleanup-held's change onto main (git merge-file, base 91c3238). Conflicts were resolved by hand, and each cut was kept only where the comment it shortens is still main's and the reason it gives survives. A check that strips comments from main's version and this one finds the same code in all six files; sh -n passes.

Kept from the held cut: the one-line headers; sysinit's getty, /etc upper-layer, devtmpfs, securityfs and efivarfs lines; installer-run's preseed, replace and verify lines; and boot-success's trial record line. The note that trial.failed, not last-result, stops a re-arm moves to the branch where it is set.

Changed from it:

  • boot-success's header names the slot booted from outside, which A slot the firmware was told to boot is not taken for the committed one #226 added after the cut.
  • esp_committed is now read at every boot with no trial on record, so the held comment ("state degraded: ...") is no longer true; it says when it is read.
  • forget_entries keeps that the committed slot's own firmware entry is a second way to it should BOOTX64.EFI be lost.
  • testctl's header keeps both reasons: read only on a medium, so the disk cannot reinstall or shut down an installed system; and only when signed, so no other disk can arm an install. Its key list is the thirteen keys main reads; the held list lacked install_slot_mib, install_keyboard and the header recovery mode.
  • time-floor's header keeps the newest committed release as the floor (The clock's floor stays at the newest release committed to #181).
  • sysinit keeps a one-line list of the state's three kinds, and why the consent directory is setgid.

Dropped:

  • The shortened section rulers in boot-success.sh: churn.
  • installer-run's shellcheck line: the held one predates slot_arg and kbd_arg.
  • sysinit's table of where privileged things come from: docs/design/boot-and-updates.md says it.

Proof: CI (shellcheck, syntax, the fixture suites). Nothing the image does changes, so there's no Distro run.

…s kept: cleanup-held's cut of build/recipes/services.sh and five service scripts, redone on main by hand, comments only

From 65a6fbb, taken where the comment it shortens is still main's and the reason survives. Changed from it: boot-success's header names the slot booted from outside (#226), esp_committed is read at every boot with no trial on record, not only on a degraded state, and forget_entries keeps that the committed slot's own entry is a second way to it; testctl keeps why a control disk is read only on a medium and only when signed, and its key list is the thirteen keys main reads; time-floor keeps the newest committed release (#181); sysinit keeps a one-line list of the state's three kinds and why the consent directory is setgid. Dropped: the shortened section rulers (churn) and installer-run's shellcheck line, which predates slot_arg and kbd_arg.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant