815342 - GCLI commands with optional options have misleading synopsis

Status: RESOLVED DUPLICATE of bug 799769

(DevTools Graveyard :: Graphic Commandline and Toolbar, defect)

Description

[Michael Beckwith]

User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:18.0) Gecko/18.0 Firefox/18.0
Build ID: 20121119042013

Steps to reproduce:

Ran the screenshot command via the Developer Toolbar


Actual results:

Synopsis information is not uptodate with current method of adding parameters.


Expected results:

New --flag style should have been shown instead of "screenshot false true 0" etc

Comment 1

[Ioana (away)]

Michael, could you please attach the file you used screenshot with to this bug report?

We need to reproduce the bug in order to cofirm it, and I couldn't reproduce it with Firefox 18 or 20 until now.

Comment 2

[Victor Porof [:vporof][:vp]]

Michael is referring to typing the --arguments, which aren't immediately obvious in gcli. For example, writing 'screenshot file' would show an [options] placeholder, which signals that extra arguments can be added, but there's no way of discovering that typing -- is required to display them. This bug affects all commands that use this variable-number-of-arguments pattern. CCing Joe.

Comment 3

[Ioana (away)]

Thanks for the details, Victor.

Reproducible on the latest Nightly too (11/26).

Comment 4

[Girish Sharma [:Optimizer]]

Changing the summary of the bug to reflect a general use case

Comment 5

[Joe Walker [:jwalker]]

Agreed.

There is an extenuating circumstance here in that Kevin's video highlights the old way. Also it could be argued that using '-' (you only need one) is common-place in command lines.

However that's not to say that we shouldn't improve things, and it's something I'll bear in mind.

Thanks for the report.

Comment 6

[Michael Beckwith]

Still need anything from me? or are we good to go?

Comment 7

[Joe Walker [:jwalker]]

(In reply to Michael Beckwith from comment #6)
> Still need anything from me? or are we good to go?

I think we understand the problem, thanks.

Comment 8

[Joe Walker [:jwalker]]

New component triage. Filter on "Lobster Thermidor aux crevettes with a Mornay sauce"