Fix nix help shell by properly handling command aliases (backport #13496)
#13499
Conversation
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
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
Previously, `nix help shell` failed with "Nix has no subcommand 'shell'" despite `nix shell --help` working correctly. This happened because the `shell` command is actually an alias for `env shell`, and the help system wasn't resolving aliases when looking up documentation. This patch modifies the `showHelp` function to check for and resolve aliases before generating the manpage name, ensuring that shorthand commands like `shell` get proper help documentation. Closes: #13431 (cherry picked from commit d678b07)
mergify
bot
added
automatic backport
mergify
bot
added
merge-queue
automatic backport
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix
nix help shellby properly handling command aliasesCloses: #13431
Problem
The
nix help shellcommand incorrectly fails withNix has no subcommand 'shell'despitenix shell --helpworking correctly. This happens becauseshellis actually an alias forenv shell, and the help system wasn't resolving these aliases when looking up documentation.This creates a confusing user experience where the shell command both exists and doesn't exist depending on how users try to access its documentation.
Solution
This PR modifies the
showHelpfunction insrc/nix/main.ccto check for and resolve aliases before generating the manpage name. When a user requests help for an aliased command likeshell, the system now correctly looks up the documentation for the actual command (env shell).The implementation is straightforward - it adds a few lines to the
showHelpfunction to check if the requested subcommand matches any aliases in thetoplevel.aliasesmap, and if so, replaces the subcommand with the actual command path before generating the manpage name.This is an automatic backport of pull request #13496 done by Mergify.