Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that /loader/entries should be in the root of the ESP filesystem #68

Merged
merged 1 commit into from
Aug 22, 2023

Conversation

DaanDeMeyer
Copy link
Member

The current wording sometimes gets misinterpreted as having to search for /loader/entries on all filesystems in the partition table so let's clarify that /loader/entries should be located on the root of the ESP filesystem.

@@ -170,7 +170,7 @@ only: while boot loaders should look in both places, OSes should only add their
files to `$BOOT`.

**Note:** _In all cases the `/loader/entries/` directory should be located
directly in the root of the file system. Specifically, the `/loader/entries/`
directly in the root of the ESP file system. Specifically, the `/loader/entries/`
Copy link
Member

Choose a reason for hiding this comment

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

No, because it can be on ESP or on XBOOTLDR. So this phrasing is also wrong.

@DaanDeMeyer DaanDeMeyer force-pushed the clarify branch 2 times, most recently from 0d36605 to 5a9743a Compare August 22, 2023 11:44
@@ -170,8 +170,9 @@ only: while boot loaders should look in both places, OSes should only add their
files to `$BOOT`.

**Note:** _In all cases the `/loader/entries/` directory should be located
directly in the root of the file system. Specifically, the `/loader/entries/`
directory should **not** be located under the `/EFI/` subdirectory on the ESP._
directly in the root of the ESP or `$BOOT` file system. Specifically, the
Copy link
Member

Choose a reason for hiding this comment

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

But $BOOT can be the ESP, so why not just $BOOT?

Copy link
Member Author

Choose a reason for hiding this comment

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

Because it can also not be the ESP, and it that case we look on both the ESP and $BOOT

Copy link
Collaborator

Choose a reason for hiding this comment

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

$BOOT is supposed to indicate where we put boot entries. It points to either ESP or XBOOTLDR, depending on the local setup, and it only matters when wondering where to drop new stuff.

If we change the perspective, and are looking for boot entries, then $BOOT is not the right word to use, in particular as we actually want to look into both ESP and XBOOTLDR always. Hence, let's make this clear here, and list both dirs under their real names, not under the singleton pointer to one of them.

Hence, I think this should be rewored to say "root of the ESP or XBOOTLDR partition".

…TLDR filesystem

The current wording sometimes gets misinterpreted as having to search
for /loader/entries on all filesystems in the partition table so let's
clarify that /loader/entries should be located on the root of the ESP
or XBOOTLDR filesystem.
@poettering poettering merged commit 20b0543 into uapi-group:main Aug 22, 2023
1 check passed
@keszybz
Copy link
Member

keszybz commented Aug 22, 2023

Minor follow-up in #69.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants