[CLI help] add-cloud and add-credential are inconsistent

Bug #1793147 reported by Peter Matulis
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Canonical Juju
Fix Released
Medium
Anastasia
2.4
Won't Fix
Medium
Unassigned

Bug Description

The help for `add-cloud` shows a usage of:

juju add-cloud [options] <cloud name> <cloud definition file>

but it also lists the -f option for specifying the definition file.

The provided example does not use the -f option.

This command supports both forms.

===

The help for `add-credential` shows a usage of:

juju add-credential [options] <cloud name>

and also lists the -f option.

The provided example does use the -f option.

This command only supports the -f form.

============

So `add-cloud` is unclear because it shows the -f option that is not required and `add-credential` is wrong in terms of its listed usage. Both commands' help is also inconsistent in terms of supporting the omission of the -f option and the usage of the -f option in their examples.

I'm not sure if other commands can be used for comparison purposes in order to arrive at a consistent software design and CLI help.

Changed in juju:
status: New → Triaged
importance: Undecided → High
milestone: none → 2.5-beta1
Changed in juju:
milestone: 2.5-beta1 → 2.5-beta2
Changed in juju:
milestone: 2.5-beta2 → 2.5.1
Ian Booth (wallyworld)
Changed in juju:
milestone: 2.5.1 → 2.5.2
Changed in juju:
milestone: 2.5.2 → 2.5.3
Revision history for this message
Anastasia (anastasia-macmood) wrote :

I had a closer look at both commands' help.

Whilst I agree that we could be more explicit with explanation of interchangeable file as an argument and as a parameter on 'add-cloud' command (see PR https://github.com/juju/juju/pull/9941), I am not sure that I see a problem on add-credential. We do not usually show the usage of all options in the examples. We usually only show a representative subset of example and avoid enumerating all combinations and possibilities. If you disagree, feel free to open a separate bug, dedicated to 'add-credential' help only with your suggestion.

Changed in juju:
status: Triaged → In Progress
assignee: nobody → Anastasia (anastasia-macmood)
milestone: 2.5.3 → 2.6-beta1
importance: High → Medium
tags: added: usability
Revision history for this message
Anastasia (anastasia-macmood) wrote :

As this is a usability bug, just a correction in command help, it was mis-triaged as High (a category usually reserved for functional changes). Also we are not likely to backport it to previous Juju versions. So, I have re-targeted this correction to go into current development branch that is heading into 2.6.

Changed in juju:
status: In Progress → Fix Committed
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.