juju help promotes the 'wrong' versions of commands
Bug #1299120 reported by
Nick Veitch
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
juju-core |
Fix Released
|
Low
|
Jesse Meek |
Bug Description
There are several commands whose docstrings report through "juju help commands", that they are aliases of other commands. This tends to suggest that the commands they are aliases of are the preferred versions, when in fact it is the other way around. E.g.
remove-machine
remove-relation
remove-service
remove-unit
generate-config
These aliases were created to make the commands more logical and user-friendly. Ideally we should list these as the 'real' commands and deprecate the older versions (at least remove them from help) as per list discussion.
Related branches
lp:~waigani/juju-core/cmd_help_aliases_1299120
- Juju Engineering: Pending requested
-
Diff: 499 lines (+98/-91)10 files modifiedcmd/juju/cmd_test.go (+5/-5)
cmd/juju/main.go (+4/-4)
cmd/juju/removemachine.go (+19/-12)
cmd/juju/removemachine_test.go (+18/-18)
cmd/juju/removerelation.go (+8/-8)
cmd/juju/removerelation_test.go (+9/-9)
cmd/juju/removeservice.go (+9/-9)
cmd/juju/removeservice_test.go (+12/-12)
cmd/juju/removeunit.go (+8/-8)
cmd/juju/removeunit_test.go (+6/-6)
Changed in juju-core: | |
assignee: | nobody → Jesse Meek (waigani) |
milestone: | none → 1.19.2 |
Changed in juju-core: | |
milestone: | 1.19.2 → next-stable |
status: | Triaged → In Progress |
Changed in juju-core: | |
status: | In Progress → Fix Committed |
Changed in juju-core: | |
milestone: | next-stable → 1.19.3 |
Changed in juju-core: | |
status: | Fix Committed → Fix Released |
To post a comment you must log in.
Essentially it means that internally we need to rename the types and their registered name, and then move the old name into the alias.
It isn't particularly hard to do, but it is a bit cumbersome, and not a focus point right now.
it probably wouldn't take someone particularly long if they need some mostly-mechanical coding time.