docs: fix broken links and add inventory_win#5900
docs: fix broken links and add inventory_win#5900eriknordmark wants to merge 1 commit intolf-edge:masterfrom
Conversation
eriknordmark
force-pushed
the
eriknordmark/doc-consistency-fixes
branch
from
3b1911f to
c3b8ae0
Compare
There was a problem hiding this comment.
Please, let's take this opportunity to fix these few Yetus errors and make the whole file pass....
There was a problem hiding this comment.
They should be fixed now.
rene
left a comment
rene
left a comment
There was a problem hiding this comment.
The broken-link fixes (SECURITY.md → SECURITY-ARCHITECTURE.md) across BOOTING.md, KEYS-AND-CERTS.md, and README.md are all correct — SECURITY-ARCHITECTURE.md exists and SECURITY.md does not. The inventory_win addition and persist removal in BUILD.md are backed by the actual code (Makefile:910 and pkg/mkimage-raw-efi/make-raw:do_inventory_win()). The macOS capitalization fix is correct.
One remaining inconsistency in BUILD.md: steps 3 and 4 (lines 313–314, outside this diff) still describe the old partition set "efi imga conf_win", but the Makefile actually invokes "efi conf_win installer inventory_win". Those two steps could be updated in this PR since the section is already open for edits.
| 0. Calculates required size of the resulting image if '-C' option is provided | ||
| 1. Extracts the contents of the tar stream to `/parts/` | ||
| 2. Creates a partition for each of `efi`, `imga`, `conf_win` | ||
| 2. Creates a partition for each of `efi`, `imga`, `conf_win`, `inventory_win` |
There was a problem hiding this comment.
The new list still says imga here, but Makefile:910 passes "efi conf_win installer inventory_win" — the installer rootfs partition is named installer, not imga. Steps 3 and 4 just above (lines 313–314, not in this diff) have the same issue. Worth fixing all three while this section is already being edited.
| * `conf_win`: contents of `/parts/config.img` as partition type `EBD0A0A2-B9E5-4433-87C0-68B6B72699C7`, or Windows Data partition. Other than the partition type, `conf_win` is identical to `conf`. This is required so that this partition can be mounted on MacOS and Windows machines for users to add/change configuration on an installer image in between installs. | ||
| * `persist`: contents of `/parts/persist.img` if it exists, else empty | ||
| * `conf_win`: contents of `/parts/config.img` as partition type `EBD0A0A2-B9E5-4433-87C0-68B6B72699C7`, or Windows Data partition. Other than the partition type, `conf_win` is identical to `conf`. This is required so that this partition can be mounted on macOS and Windows machines for users to add/change configuration on an installer image in between installs. | ||
| * `inventory_win`: an empty Windows Data partition labeled INVENTORY, also mountable on macOS and Windows. |
There was a problem hiding this comment.
Nit: for consistency with the conf_win bullet above, consider adding the partition type GUID, e.g.:
* `inventory_win`: an empty Windows Data partition (`EBD0A0A2-B9E5-4433-87C0-68B6B72699C7`) labeled `INVENTORY`, mountable on macOS and Windows.
|
@eriknordmark , atm, except by this comment: #5900 (comment) the others were made by Claude (reviewed from claude code, so I didn't find a better way to push the comments) - I'm doing some experiments.... |
Fix 8 broken references to SECURITY.md (the file is named SECURITY-ARCHITECTURE.md) in BOOTING.md, KEYS-AND-CERTS.md, and README.md. Add the missing inventory_win partition to the installer image partition description in BUILD.md. The installer image creates four partitions (efi, imga, conf_win, inventory_win), where conf_win and inventory_win are FAT32/Windows Data partitions mountable on macOS and Windows. Also remove the stale persist bullet from the installer partition list, which contradicted the earlier statement that the installer does not create a persist partition. Signed-off-by: eriknordmark <erik@zededa.com> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
eriknordmark
force-pushed
the
eriknordmark/doc-consistency-fixes
branch
from
c3b8ae0 to
8703ec4
Compare
2 participants
Description
Fix documentation inconsistencies found by auditing the
docs/directory.How to test and validate this PR
Documentation-only change. Verify that:
SECURITY-ARCHITECTURE.mdin the affected files resolve correctly.inventory_winpartition description inBUILD.mdis consistent withMakefileandpkg/mkimage-raw-efi/make-raw.Changelog notes
None.
PR Backports
Checklist