1045273 - [gcli] optional parameters labeled as 'helpManOptional', not as optional in help

Status: RESOLVED FIXED

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

Description

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

Firefox Nightly 34.0a1 20140728030201 on Windows 8.1

The options which are optional in the GCLI are labeled as helpManOptional, the strings ID which should be shown here.

Example:
Type |help highlight|.

Look at the description of --region and --fill.

Comment 1

[Joe Walker [:jwalker]]

The failure is probably in the usage from toolkit/devtools/gcli/source/lib/gcli/commands/help.js

Comment 2

[Adrien Pachkoff [:pandark]]

Attachment: bug-1045273.patch

Comment 3

[Joe Walker [:jwalker]]

Thanks Adrien, do you want me to push to try?

Comment 4

[Sushrut Bhalla]

Hi,

I am new on this project and would like to accept the bug.
How do I accept the bug?.
Thanks,
Sushrut

Comment 5

[Joe Walker [:jwalker]]

(In reply to Sushrut Bhalla from comment #4)
> Hi,
> 
> I am new on this project and would like to accept the bug.
> How do I accept the bug?.
> Thanks,
> Sushrut

This bug is being worked on by Adrien, whose done one patch and is half way through a second. Can I suggest a couple of alternatives?

* Bug 1043896
* Bug 992386

Comment 6

[Adrien Pachkoff [:pandark]]

Attachment: bug-1045273-2.patch

A little overdue, but here is the second patch :)

Comment 7

[Adrien Pachkoff [:pandark]]

Attachment: bug-1045273.patch

Comment 8

[Joe Walker [:jwalker]]

https://tbpl.mozilla.org/?tree=Try&rev=a911ffaab04c

Comment 9

[Joe Walker [:jwalker]]

Nice work Adrien. You asked about other bugs. I've not looked at bug 1038251 very much, so it's a bit of an known quantity, but you did a good job of tracking down the unknown parts of this one. What do you think?

Comment 10

[rctgamer3]

Encountered this bug today:
(Aurora 34.0a2 (2014-09-07))

"Failed to format " "helpManOptional"
TypeError: swaps is undefined
l10n.js:86

Stack trace:
exports.lookupFormat@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/util/l10n.js:83:5
getHelpManData/<.getTypeDescription@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/commands/help.js:68:17
@resource://gre/modules/devtools/Templater.jsm line 570 > eval:1:1
envEval@resource://gre/modules/devtools/Templater.jsm:570:16
processTextNode/<@resource://gre/modules/devtools/Templater.jsm:413:1
processTextNode@resource://gre/modules/devtools/Templater.jsm:408:5
processNode@resource://gre/modules/devtools/Templater.jsm:215:7
processNode@resource://gre/modules/devtools/Templater.jsm:211:7
processNode@resource://gre/modules/devtools/Templater.jsm:211:7
processForEachMember/<@resource://gre/modules/devtools/Templater.jsm:375:11
handleAsync@resource://gre/modules/devtools/Templater.jsm:482:5
processForEachMember@resource://gre/modules/devtools/Templater.jsm:356:5
processForEachLoop/<@resource://gre/modules/devtools/Templater.jsm:326:1
processForEachLoop@resource://gre/modules/devtools/Templater.jsm:325:5
processForEach/<@resource://gre/modules/devtools/Templater.jsm:299:9
handleAsync@resource://gre/modules/devtools/Templater.jsm:482:5
processForEach@resource://gre/modules/devtools/Templater.jsm:298:7
processNode@resource://gre/modules/devtools/Templater.jsm:119:9
processNode@resource://gre/modules/devtools/Templater.jsm:211:7
processNode@resource://gre/modules/devtools/Templater.jsm:211:7
processForEachMember/<@resource://gre/modules/devtools/Templater.jsm:375:11
handleAsync@resource://gre/modules/devtools/Templater.jsm:482:5
processForEachMember@resource://gre/modules/devtools/Templater.jsm:356:5
processForEachLoop@resource://gre/modules/devtools/Templater.jsm:333:9
processForEach/<@resource://gre/modules/devtools/Templater.jsm:299:9
handleAsync@resource://gre/modules/devtools/Templater.jsm:482:5
processForEach@resource://gre/modules/devtools/Templater.jsm:298:7
processNode@resource://gre/modules/devtools/Templater.jsm:119:9
processNode@resource://gre/modules/devtools/Templater.jsm:211:7
processNode@resource://gre/modules/devtools/Templater.jsm:211:7
template@resource://gre/modules/devtools/Templater.jsm:69:3
exports.createView/<.toDom@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/ui/view.js:83:7
viewDomConverter.exec@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/converters/converters.js:58:12
getChainConverter/<.exec@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/converters/converters.js:131:14
Converters.prototype.convert/<@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/converters/converters.js:244:14
createAsyncFunction/asyncFunction@resource://gre/modules/Task.jsm:239:18
Task_spawn@resource://gre/modules/Task.jsm:164:12
exports.exec@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/util/host.js:72:10
Converters.prototype.convert@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/converters/converters.js:243:12
Output.prototype.convert@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/cli.js:2193:10
OutputPanel.prototype._update@resource://app/modules/devtools/DeveloperToolbar.jsm:975:5
resolve@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/deprecated-sync-thenables.js:40:40
then@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/deprecated-sync-thenables.js:20:43
resolve@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/deprecated-sync-thenables.js:72:11
Output.prototype.complete@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/cli.js:2186:3
Requisition.prototype.exec/onDone@resource://gre/modules/commonjs/toolkit/loader.js -> resource://gre/modules/devtools/gcli/cli.js:2059:5
Handler.prototype.process@resource://gre/modules/Promise.jsm -> resource://gre/modules/Promise-backend.js:865:23
this.PromiseWalker.walkerLoop@resource://gre/modules/Promise.jsm -> resource://gre/modules/Promise-backend.js:744:7

Comment 11

[Josh Matthews [:jdm]]

Joe, should this patch be merged? It's been sitting on an r+ for some time now.

Comment 12

[Joe Walker [:jwalker]]

Thanks, Josh - yes it should. I'll make sure we land it.

Mike - please could you take a look at this patch? I think it's fine, but we should probably re-try.

Comment 13

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=eb602427f99d

Comment 14

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

Try:
https://treeherder.mozilla.org/#/jobs?repo=try&revision=e1fbffbfb92f
https://tbpl.mozilla.org/?tree=Try&rev=e1fbffbfb92f

Comment 15

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

What happened here?  Can we land something?

Comment 16

[Joe Walker [:jwalker]]

I'm guessing that it's a rebase away from being landable. Not sure why we didn't land previously.

Comment 17

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

(In reply to J. Ryan Stinnett [:jryans] (use ni?) from comment #15)
> What happened here?  Can we land something?

I remember that it failed on try... can't remember why though.

@Adrien: Do you feel like rebasing this patch?

Comment 18

[Michael Kim [:mkdrive2]]

Hello, I am new to Open Source programming. I would like to know what "landing" something and "rebasing" a patch means.

Also, I cannot find the mentioned folder "toolkit/devtools/gcli/source/lib/gcli/commands/" on my source directory. I can find "mozilla-central/toolkit/" but there is no folder "devtools" in there. Was it removed?

Comment 19

[Joe Walker [:jwalker]]

Land = Get a patch committed to mozilla-central
Rebase = Take an old patch and make it up to date

toolkit/devtools/gcli/source/lib/gcli/commands/ -> devtools/shared/gcli/commands

Comment 20

[Adrien Pachkoff [:pandark]]

Hello,
It's been… a while :)
I'll have to set everything up again, so I'll probably give it a try after FOSDEM (next week).

Comment 21

[Stoyan Dimitrov [:stoyan]]

I tried to rebase the patch and it turned out to be the same as the the original. Since I can not see the failed "try" can we spin it one more time?

Comment 22

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

(In reply to Stoyan Dimitrov [:stoyan] from comment #21)
> I tried to rebase the patch and it turned out to be the same as the the
> original. Since I can not see the failed "try" can we spin it one more time?

It probably looks the same but that will be because the files have moved:
  - toolkit/devtools/gcli/source/lib/gcli/commands/commands.js is now at devtools/shared/gcli/source/lib/gcli/commands/commands.js
  - toolkit/devtools/gcli/source/lib/gcli/commands/help.js is now at devtools/shared/gcli/source/lib/gcli/commands/help.js

So to rebase the patch you will need to first update the paths in the diff file.

Comment 23

[Stoyan Dimitrov [:stoyan]]

Attachment: Rebased version of the original patch

Comment 24

[Stoyan Dimitrov [:stoyan]]

I guess we are good for a "try" now.

Comment 25

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=a62a34975548a6609046a2573a11e81b8a511172

Comment 26

[Stoyan Dimitrov [:stoyan]]

Comment on attachment 8854407 [details] [diff] [review]
Rebased version of the original patch

r? miker as per IRC conversation with jwalker.

Comment 27

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/76cd22c6aa18bb66152139f90c3612ad4795399c
Bug 1045273 - "[gcli] optional parameters labeled as 'helpManOptional', not as optional in help" r=mratcliffe

Comment 28

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/76cd22c6aa18