help text does not include --debug as an option

Bug #1628151 reported by Nick Veitch
38
This bug affects 7 people
Affects Status Importance Assigned to Milestone
Canonical Juju
Fix Released
Medium
Anastasia
2.5
Fix Released
Medium
Anastasia

Bug Description

The help text output for juju doesn't list the --debug option along with the other ooptions available for a command.

Changed in juju:
status: New → Triaged
importance: Undecided → Medium
milestone: none → 2.0.0
tags: added: usability
Curtis Hovey (sinzui)
Changed in juju:
milestone: 2.0.0 → 2.0.1
Curtis Hovey (sinzui)
Changed in juju:
milestone: 2.0.1 → none
Changed in juju:
assignee: nobody → Anastasia (anastasia-macmood)
status: Triaged → In Progress
Revision history for this message
Anastasia (anastasia-macmood) wrote :

From a conversation elsewhere...

From howbazaar:

I feel that what we really want is a section in the help that lists all the inherited flags from the supercommand.
--debug
--show-log
--logging-config
--verbose
--quiet

There is a reason we don't have these on every single command, but if we could have them grouped, it would be more palatable. Although this probably needs to be fixed at the github.com/juju/cmd package level.

From @anastasiamac:

Agreed, I feel like we should have all these options available through 'help' on every command. I am happy to group them after all the command options, although I do not see why we cannot just mix supercommand options among command-specific options and order all alphabetically. I'll add this to the bug.

Revision history for this message
Peter Matulis (petermatulis) wrote :

Please also see `juju help global-options`.

Revision history for this message
Anastasia (anastasia-macmood) wrote :

Personally, I do not like the idea of 'juju help global-options' because you need to know that those exist, you need to know how to look for them, etc.

All options that a command can use should be listed as part of the help for that command.

Revision history for this message
Anastasia (anastasia-macmood) wrote :
Revision history for this message
Anastasia (anastasia-macmood) wrote :

There is the desire to have Global Options grouped separately from the command-specific options. To achieve this, the initial work needs to happen in juju/cmd. I will close the PR I've proposed in juju/juju and will circle back to it when ready.

Revision history for this message
Anastasia (anastasia-macmood) wrote :

As it was decided that global options are best grouped, I have written a new PR for juju/cmd - https://github.com/juju/cmd/pull/60

Once this lands, it will be a one line production code change to enable Juju to display gloabl options on command help.

Revision history for this message
Anastasia (anastasia-macmood) wrote :

Juju PR against develop (heading into 2.6): https://github.com/juju/juju/pull/9633

Changed in juju:
milestone: none → 2.6-beta1
Changed in juju:
status: In Progress → Fix Committed
Revision history for this message
Anastasia (anastasia-macmood) wrote :
Changed in juju:
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.