Skip to content

Fix ethtool path in Wake-on-LAN documentation#498

Merged
elibosley merged 1 commit into
unraid:mainfrom
polecter:patch-1
Jun 3, 2026
Merged

Fix ethtool path in Wake-on-LAN documentation#498
elibosley merged 1 commit into
unraid:mainfrom
polecter:patch-1

Conversation

@polecter
Copy link
Copy Markdown
Contributor

@polecter polecter commented Jun 3, 2026

On Unraid 7.2.4, ethtool is installed at:

/usr/sbin/ethtool

while:

/sbin/ethtool

does not exist.

As a result, the command currently documented in the Wake-on-LAN guide fails when copied directly into /boot/config/go.

This PR updates the path to match the current installation location.

Summary by CodeRabbit

  • Documentation
    • Updated Wake-on-LAN manual configuration instructions with corrected system command path for improved setup accuracy.

On Unraid 7.2.4, ethtool is installed at /usr/sbin/ethtool while /sbin/ethtool does not exist. Since this command is intended for /boot/config/go, keeping an absolute path is appropriate, but the path should be updated to /usr/sbin/ethtool.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation correction to the Wake-on-LAN manual persistence instructions. The ethtool command path in the boot go file snippet is updated from /sbin/ethtool to /usr/sbin/ethtool to reflect the correct system binary location.

Changes

WoL Documentation

Layer / File(s) Summary
WoL ethtool command path
docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx
The manual persistence example for WoL settings corrects the ethtool binary path from /sbin/ethtool to /usr/sbin/ethtool in the boot go file snippet.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through the docs with care, 🐰
Finding paths that were never quite fair,
From /sbin to /usr/sbin it goes,
Wake-on-LAN's now properly composed! ✨
One little hop makes the system just right.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description explains the issue and solution clearly, but does not follow the required template with its checklist items. Fill out the pull request template checklist to confirm all documentation standards have been met before merging.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and specifically describes the main change: fixing the ethtool path in Wake-on-LAN documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx`:
- Line 90: Update the translated wake-on-lan documents to match the source
command path: replace instances of "/sbin/ethtool" with "/usr/sbin/ethtool" in
each locale copy of wake-on-lan.mdx (e.g., the files under i18n/de/, i18n/fr/,
i18n/es/, i18n/ja/, i18n/zh/). Search for the literal string "/sbin/ethtool -s"
or "/sbin/ethtool" in those translation files and update them to
"/usr/sbin/ethtool -s" so the examples match the source docs.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 0afd2f72-c32c-43db-a717-04b2881e61df

📥 Commits

Reviewing files that changed from the base of the PR and between 60a3ca3 and 40491ef.

📒 Files selected for processing (1)
  • docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx


```
/sbin/ethtool -s eth0 wol g
/usr/sbin/ethtool -s eth0 wol g
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.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Find all translation files with the outdated ethtool path

# Search for the old path in translation directories
rg -n '/sbin/ethtool' --glob 'i18n/**/wake-on-lan.mdx'

Repository: unraid/docs

Length of output: 770


Update the ethtool path in translated WoL docs (multiple locales).

Source docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx uses /usr/sbin/ethtool, but the wake-on-lan.mdx translations still reference /sbin/ethtool in: i18n/de/..., i18n/fr/..., i18n/es/..., i18n/ja/..., and i18n/zh/..., which will break the copied command for those users.

Expected fix for German
-  /sbin/ethtool -s eth0 wol g
+  /usr/sbin/ethtool -s eth0 wol g
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx` at line
90, Update the translated wake-on-lan documents to match the source command
path: replace instances of "/sbin/ethtool" with "/usr/sbin/ethtool" in each
locale copy of wake-on-lan.mdx (e.g., the files under i18n/de/, i18n/fr/,
i18n/es/, i18n/ja/, i18n/zh/). Search for the literal string "/sbin/ethtool -s"
or "/sbin/ethtool" in those translation files and update them to
"/usr/sbin/ethtool -s" so the examples match the source docs.

@elibosley elibosley merged commit d7dfbb8 into unraid:main Jun 3, 2026
2 checks passed
@elibosley
Copy link
Copy Markdown
Member

Thank you!

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 3, 2026

Cloudflare Preview

Preview URL: https://pr-498.docs-efm.pages.dev
Source branch: patch-1
Run: https://github.com/unraid/docs/actions/runs/26905464070

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.

2 participants