'netplan help' doesn't work as expected

Bug #1748629 reported by Mark Shuttleworth
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Netplan
Fix Released
High
Unassigned
nplan (Ubuntu)
Fix Released
High
Mathieu Trudel-Lapierre

Bug Description

This is unexpected:

$ sudo netplan help
usage: netplan [-h] [--debug] ...
netplan: error: argument : invalid choice: 'help' (choose from 'generate', 'apply', 'ifupdown-migrate')

Please could 'netplan help' do the same as 'netplan -h'?

Revision history for this message
Mathieu Trudel-Lapierre (cyphermox) wrote :

Triaging.

I agree, I'd want 'netplan <*> help' to work everywhere, and I had run into trouble with the rest of the command parsing. I believe I've fixed the parsing appropriately now, so we do need to revisit the help command.

Let's tag this 'bitesize'; I believe it should be approachable by new contributors (dja?) as a nice way to get familiar with the codebase.

Changed in netplan:
status: New → Triaged
importance: Undecided → High
Revision history for this message
Mathieu Trudel-Lapierre (cyphermox) wrote :

This should be High priority; fixing this has a high benefit to our users for relatively little work.

Revision history for this message
Mathieu Trudel-Lapierre (cyphermox) wrote :

In Progress: I've fixed up 'help' for all commands/subcommands, and that should now get automatically set up for new netplan commands. Code is in https://github.com/CanonicalLtd/netplan/tree/help_command; I will merge this as part of release 0.34.

Changed in netplan:
status: Triaged → In Progress
Changed in nplan (Ubuntu):
status: New → In Progress
importance: Undecided → High
assignee: nobody → Mathieu Trudel-Lapierre (cyphermox)
Changed in netplan:
status: In Progress → Fix Committed
Revision history for this message
Eric Desrochers (slashd) wrote :

* Fix Released in version 0.34

netplan.io (0.34) bionic; urgency=medium
    * Implement 'help' as a subcommand of any netplan command, so that running
      'netplan * help' always returns some helpful information. (LP: #1748629)

Changed in nplan (Ubuntu):
status: In Progress → Fix Released
Daniel Axtens (daxtens)
Changed in netplan:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.