Remove unnecessary GRUB userspace tools and other files

[sairon]

Because the OTA hooks interact with GRUB environment using grub-editenv, we have BR2_TARGET_GRUB2_INSTALL_TOOLS enabled. However, that brings massive bloat of files that are never used in HAOS, as it also installs many other binaries, GRUB modules and translations.

As it's not possible to configure what gets installed in grub2 package, remove the undesired files in the post-build function. This brings savings of ~8.5MB of space in the root partition.

Summary by CodeRabbit

• Chores
  • Improved system housekeeping by removing unnecessary GRUB components to streamline the environment and reduce clutter.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update the fix_rootfs function in the buildroot-external/scripts/rootfs-layer.sh script by adding cleanup steps for GRUB-related components. The script now uses the find command to delete all files matching the pattern "grub-*" (excluding "grub-editenv") from both /usr/bin and /usr/sbin. It also removes the /etc/grub.d and /usr/lib/grub directories, and, if present, deletes "grub.mo" files and cleans up empty directories under /share/locale.

Changes

File	Change Summary
buildroot-external/scripts/rootfs-layer.sh	Enhanced the fix_rootfs cleanup by removing GRUB-related files/directories: - Deletes "grub-*" files (excluding "grub-editenv") from /usr/bin and /usr/sbin. - Removes /etc/grub.d and /usr/lib/grub. - If /share/locale exists, deletes "grub.mo" files and removes empty directories.

Sequence Diagram(s)

sequenceDiagram
    participant F as fix_rootfs
    participant FS as Filesystem
    F->>FS: Execute find command in /usr/bin & /usr/sbin to remove "grub-*" (exclude "grub-editenv")
    F->>FS: Remove /etc/grub.d directory
    F->>FS: Remove /usr/lib/grub directory
    alt /share/locale exists
        F->>FS: Delete "grub.mo" files and remove empty directories within /share/locale
    end
    F->>F: Complete cleanup operations

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ab51e7 and f224c2b.

📒 Files selected for processing (1)

• buildroot-external/scripts/rootfs-layer.sh (1 hunks)

🔇 Additional comments (4)

buildroot-external/scripts/rootfs-layer.sh (4)

29-29: Clear Documentation for GRUB Cleanup
The added comment clearly explains that the following commands remove unnecessary GRUB userspace tools, configuration files, modules, and translations. This helps future maintainers understand the rationale behind these cleanup steps.

---

30-30: Efficient Use of Brace Expansion in find Command
The command

find "${TARGET_DIR}"/usr/{,s}bin -name "grub-*" -not -name "grub-editenv" -delete

effectively targets both the /usr/bin and /usr/sbin directories and excludes grub-editenv from deletion. Verify that the build environment uses a shell that supports brace expansion (typically Bash 4+).

---

31-32: Appropriate Removal of GRUB Directories
Using rm -rf to remove ${TARGET_DIR}/etc/grub.d and ${TARGET_DIR}/usr/lib/grub is a straightforward way to eliminate residual GRUB configuration and module files that are not needed. This aligns with the PR objective to reduce unnecessary bloat.

---

33-36: Comprehensive Locale Cleanup Block
The conditional block checks for the existence of ${TARGET_DIR}/share/locale before deleting any grub.mo files and subsequently cleaning up empty directories. This ensures that any leftover GRUB translation files are removed while avoiding errors due to non-existent directories.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[agners]

Nice find!

I am fine doing this as a HAOS specific post-rootfs task, but ideally we'd make the GRUB2 package support installing only the tools we need. Did you look into extending the package configurability?

[sairon]

I am fine doing this as a HAOS specific post-rootfs task, but ideally we'd make the GRUB2 package support installing only the tools we need. Did you look into extending the package configurability?

I did - it's currently handled by generic make install target of GRUB. There are no toggles for changing what's installed upstream. Without that, we'd have to implement our own install handling in Buildroot makefile, which is something too specific and IMO hardly upstreamable too.