Skip to content

docs: clarify installed vs checkout mass-storage payload - #400

Open
kvnloo wants to merge 4 commits into
raspberrypi:masterfrom
kvnloo:docs/clarify-installed-mass-storage-payload
Open

kvnloo wants to merge 4 commits into
raspberrypi:masterfrom
kvnloo:docs/clarify-installed-mass-storage-payload

Conversation

@kvnloo

@kvnloo kvnloo commented Sep 29, 2026

Copy link
Copy Markdown

Summary

Clarify the difference between:

./rpiboot -d ./mass-storage-gadget64

and running rpiboot with no payload directory.

The explicit -d form uses files from the current checkout, while the no-argument form uses the installed payload under:

INSTALL_PREFIX/share/rpiboot/mass-storage-gadget64

Also document using rpiboot -v to verify the paths actually loaded and reinstalling with make install when testing local changes.

This should make stale installed-payload mismatches much easier to identify.

Refs #391

@kvnloo

kvnloo commented Oct 18, 2026

Copy link
Copy Markdown
Author

Integrated current master 0fd2663f869b7f325f4481049c60d6394855260e without rewriting the original commit. Tested/pushed head 745fb73; only Readme.md differs from current master. The doc now preserves the installed → CWD → executable-adjacent fallback order and the explicit-checkout/verbose-path guidance; rebuilding alone does not refresh installed payloads.

Native ARM64 software checks: isolated-prefix make, make install, existing test/validate-hsm-wrapper.sh signing comparisons, installed-payload hash comparison, and real rpiboot -V all passed. Explicit checkout and installed -d … -v invocations print/open their expected bootfiles.bin, then exit255 at libusb_init in this environment. No-directory selection fails before fallback selection, so that fallback is source-checked only; no physical USB boot or payload-transfer claim.

New-head CI39102394743 is action_required, zero jobs executed, not a test failure or green CI. Marking the documentation change ready for review; historical approval was on the old head, not new-head acceptance. Original authorship is preserved; current integration/verification was AI-assisted.

@kvnloo
kvnloo marked this pull request as ready for review October 18, 2026 06:07

@pelwell pelwell left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from the spurious ./s the change looks okay, which is in contrast to the unreadable slop that is the most recent comment.

Comment thread Readme.md Outdated

Once compiled, `rpiboot` can either be run locally from the source directory by specifying
the directory of the boot image e.g. `sudo ./rpiboot -d mass-storage-gadget`.
the directory of the boot image, for example `sudo ./rpiboot -d ./mass-storage-gadget64`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The leading ./ on the directory name is completely unnecessary - it does not belong in official documentation.

Comment thread Readme.md Outdated

The Raspberry Pi OS APT package sets `INSTALL_PREFIX` to `/usr`.
The Raspberry Pi OS APT package sets `INSTALL_PREFIX` to `/usr`. When debugging a
locally-built checkout, use `-d ./mass-storage-gadget64` to ensure the matching payload

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto here.

@timg236

timg236 commented Oct 23, 2026

Copy link
Copy Markdown
Collaborator

I'm seeing some merge conflicts here

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.

4 participants