docs(usage): drop sudo from --dry-run examples (#23) - #26
Merged
Merged
Conversation
check_root() skips the root check when DRY_RUN=true, so --dry-run has never needed root. The usage() help text and CLAUDE.md both still showed `sudo ./install.sh --dry-run`, contradicting the README and the actual behavior. A user reading --help rather than the README would add sudo unnecessarily. Also note "(no root needed)" in the help example, matching how the --update-mirrors examples already annotate this. Fixes #23 Claude-Session: https://claude.ai/code/session_01LoaHEAyN4UpWhihKbvg2rS
|
The diff updates two documentation lines removing sudo from --dry-run examples. No logic, conditions, or execution paths changed. VERDICT: PASS |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Removes the stale
sudoprefix from the--dry-runexamples ininstall.sh'susage()help text and inCLAUDE.md.Why
check_root()skips the root check entirely whenDRY_RUN=true, so--dry-runhas never required root. The README already documents this correctly, but two other places contradicted it:install.shusage()—sudo ./install.sh --dry-runCLAUDE.md—sudo ./install.sh --dry-run --no-fetch, directly below a comment that already read "no root needed"A user who reads
--helprather than the README would addsudounnecessarily.Issue #23 named only the
install.shline; theCLAUDE.mdoccurrence is the same defect and is fixed here too.Verification
bash -n install.sh— cleanshellcheck --severity=warning install.sh— clean (matches CI)./install.sh --dry-run --no-fetchas non-root (uid 501) — exit 0, confirming the documented behaviorDocs/help-text only; no behavior change.
Fixes #23
https://claude.ai/code/session_01LoaHEAyN4UpWhihKbvg2rS