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

Make usb_modeswitch include directory writable #3800

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Conversation

sairon
Copy link
Member

@sairon sairon commented Jan 16, 2025

The /etc/usb_modeswitch.d is present and empty but it can't be written to allow user modification. Bind-mount it like other /etc folders to make it possible to adjust usb_modeswitch config.

Fixes #3785

Summary by CodeRabbit

  • New Features
    • Added a new systemd mount unit for managing USB modeswitch persistent directory configuration
    • Ensures proper mounting of USB modeswitch configuration files during system boot

The /etc/usb_modeswitch.d is present and empty but it can't be written to allow
user modification. Bind-mount it like other /etc folders to make it possible to
adjust usb_modeswitch config.

Fixes #3785
@sairon sairon added the os label Jan 16, 2025
@sairon sairon requested a review from agners January 16, 2025 15:39
Copy link

coderabbitai bot commented Jan 16, 2025

📝 Walkthrough

Walkthrough

A new systemd mount unit file etc-usb_modeswitch.d.mount has been introduced to manage the mounting of the USB modeswitch persistent directory. The unit defines a bind mount from /mnt/overlay/etc/usb_modeswitch.d to /etc/usb_modeswitch.d, ensuring that the USB modeswitch configuration directory is properly set up during the system boot sequence. The mount is integrated into the system's boot process with specific dependencies on other mount and service units.

Changes

File Change Summary
buildroot-external/rootfs-overlay/usr/lib/systemd/system/etc-usb_modeswitch.d.mount New systemd mount unit file for binding USB modeswitch configuration directory

Sequence Diagram

sequenceDiagram
    participant Boot Process
    participant mnt-overlay.mount
    participant etc-usb_modeswitch.d.mount
    participant hassos-config.service

    Boot Process->>mnt-overlay.mount: Mount overlay filesystem
    mnt-overlay.mount-->>etc-usb_modeswitch.d.mount: Trigger USB modeswitch mount
    etc-usb_modeswitch.d.mount->>etc-usb_modeswitch.d.mount: Bind mount /mnt/overlay/etc/usb_modeswitch.d to /etc/usb_modeswitch.d
    etc-usb_modeswitch.d.mount-->>hassos-config.service: Prepare for configuration service
Loading

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
🪧 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
buildroot-external/rootfs-overlay/usr/lib/systemd/system/etc-usb_modeswitch.d.mount (1)

1-14: Consider enhancing documentation and default configuration.

While the mount unit implementation is solid, consider these enhancements:

  1. Add documentation explaining the purpose and usage of the persistent USB modeswitch configuration directory
  2. Consider providing default configuration files or templates to help users get started
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b8b1e25 and b02b39c.

📒 Files selected for processing (1)
  • buildroot-external/rootfs-overlay/usr/lib/systemd/system/etc-usb_modeswitch.d.mount (1 hunks)
🔇 Additional comments (3)
buildroot-external/rootfs-overlay/usr/lib/systemd/system/etc-usb_modeswitch.d.mount (3)

1-6: LGTM! Unit dependencies are well-defined.

The unit section correctly establishes the required dependencies and ordering:

  1. Ensures the overlay mount is available (Requires=mnt-overlay.mount)
  2. Executes after the overlay mount (After=mnt-overlay.mount)
  3. Completes before the config service (Before=hassos-config.service)

13-14: LGTM! Appropriate target selection.

The mount unit is correctly integrated into the hassos-bind.target, which is the standard target for bind mounts in the system.


7-12: Verify source directory creation and permissions.

The mount configuration looks correct, but we should verify:

  1. That the source directory is created during system initialization
  2. That both source and target directories have appropriate permissions

Let's verify the directory setup:

✅ Verification successful

Mount configuration is correctly implemented

The mount unit follows the system's standard overlay pattern and has proper dependencies:

  • Base directory provided by system package
  • Depends on overlay partition mount
  • Uses correct bind mount option
  • Follows same pattern as other system directories
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for directory creation in overlay configuration

# Check if the source directory is created in any buildroot or overlay scripts
rg -l "usb_modeswitch.d" buildroot-external/

# Look for any related permission settings
rg -l "755.*usb_modeswitch" buildroot-external/

Length of output: 178


Script:

#!/bin/bash
# Check rootfs-overlay structure and package configs
fd usb_modeswitch buildroot-external/rootfs-overlay/
fd usb_modeswitch buildroot-external/package/
fd usb_modeswitch.d buildroot-external/rootfs-overlay/

# Check systemd unit dependencies
grep -r "Requires\|After" buildroot-external/rootfs-overlay/usr/lib/systemd/system/etc-usb_modeswitch.d.mount

Length of output: 490


Script:

#!/bin/bash
# Check for base package configuration and overlay mount
rg -l "BR2_PACKAGE.*usb.?modeswitch" buildroot-external/
rg -l "mnt-overlay.mount" buildroot-external/

# Check overlay configuration
cat buildroot-external/rootfs-overlay/usr/lib/systemd/system/mnt-overlay.mount

Length of output: 1931

@sairon sairon merged commit 6ef7a68 into dev Jan 16, 2025
3 checks passed
@sairon sairon deleted the writable-usb-modeswitch.d branch January 16, 2025 17:11
@sairon sairon mentioned this pull request Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants