docs: document the mcpp-short-cmd aliases in both READMEs (#313) - #323
Merged
Conversation
`xlings install mcpp-short-cmd -y` has shipped (openxlings/xim-pkgindex pkgs/m/mcpp-short-cmd.lua) but nothing in this repo mentioned it, so the answer to "does mcpp support command aliases" read as "no, write them into your shell rc yourself". Folded in under the recommended xlings install rather than as another numbered option: it is not a way to install mcpp, it is a thing you can add after installing it. Both tables are generated from the descriptor's SHORT_CMDS map and checked against it entry by entry — 30/30, no drift. The naming rule is stated so the table is a reference, not something to memorise: initial of every word but the last, last word in full (`mcpp self doctor` -> `msdoctor`).
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
2 participants
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.
Covers the "命令自身支持别名调用" item in #313.
xlings install mcpp-short-cmd -yalready ships(xim-pkgindex
pkgs/m/mcpp-short-cmd.lua),but nothing in this repo mentioned it — so the answer to "does mcpp support
aliases" read as "no, add them to your shell rc yourself".
Where it goes
Under the recommended
xlings install mcppblock, as a collapsed<details>— not a new numbered option. It isn't a way to install mcpp; it'ssomething you add after installing it. Collapsed keeps a 30-row table out of
the way of first-time readers.
Both
README.mdandREADME.zh-CN.md.Content
One command, the naming rule, and the full table:
The rule is stated so the table works as a reference rather than something to
memorise, and the shim detail answers the obvious follow-up ("do the short
commands still point at the old version after I switch?").
Verified
Both tables were diffed entry-by-entry against the descriptor's
SHORT_CMDSmap: 30/30 present, no extras, no wrong expansion, in both languages.
Worth doing — a hand-copied alias table is exactly the kind of thing that
silently drifts one entry.