614343 - update cfx tool reference to match --help changes

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

The cfx tool reference should be updated to match the changes to the cfx tool's --help docs that are described in bug 614130 (also see bug 614128 and bug 614129).

Comment 1

[Myk Melez [:myk] [@mykmelez]]

Will: is this something you might be able to take on?

Comment 2

[Atul Varma [:atul]]

If Will can't take it on, I should be able to bust it up.

Comment 3

[Will Bamberg [:wbamberg]]

Sure.

Comment 4

[Will Bamberg [:wbamberg]]

What should we do with --profile-memory and --logfile? There's some discussion in 614128 about them but I'm not sure of the resolution. Moving them both to Internal seems like the right thing to do today.

And does that also means that 614130 should be reworked to make this distinction?

Comment 5

[Atul Varma [:atul]]

Yeah, that seems reasonable to me, Will.

Comment 6

[Will Bamberg [:wbamberg]]

Attachment: Fix for bug614343

Here's an attempted fix via pull request. I managed to make 2 pull requests (59 and 60) that are the same, but not sure how to revoke one of them.

Comment 7

[Atul Varma [:atul]]

Comment on attachment 493715 [details] [diff] [review]
Fix for bug614343

Hmm, there seem to be a number of changes made by bug 614129 that haven't been addressed here... For instance, --dep-tests was renamed to --dependencies and its shortcut was removed, yet as far as I can tell both changes aren't reflected in the Web documentation for cfx.

Let me know if I'm missing something, though... Definitely looking forward to a time when we don't have to separately maintain two separate versions of the cfx documentation!

Comment 8

[Will Bamberg [:wbamberg]]

No, you're right, sorry. I had assumed that it was only the supported/experimental/internal changes to be made here, but I'll check all of them against the current output of cfx --help.

Comment 9

[Will Bamberg [:wbamberg]]

Attachment: Updated pull request

I've updated the pull request with another commit containing much more extensive changes.

It should be the same as the description in attachment 493202 [details], except for --logfile and --profile-memory being included, with no short form, and put in the 'Internal' category.

Comment 10

[Atul Varma [:atul]]

Comment on attachment 493816 [details] [diff] [review]
Updated pull request

This looks great! I mentioned a few nits on the pull request page but I'm also cool with just pulling your branch as-is. Let me know which you prefer!

Comment 11

[Will Bamberg [:wbamberg]]

Hey Atul

I pushed fixes for most of those nits to that branch, if you could pull it now that would be great. 

I didn't make this change:

> isn't -g/--use-config a global option?

...because cfx --help don't list it as a global option, unlike -v and -h. So either we change both or we change neither. I think the substantive question is whether we want to enforce that "-g" precedes the command or not.  

> Definitely looking forward to a
> time when we don't have to separately maintain
> two separate versions of the cfx
> documentation!

Absolutely, although other than changing this page to read "Run `cfx --help`" I'm not sure how to achieve that... 

It is a bit odd having a page that really just reproduces the command-line help, and it might be better eventually to have a cfx page that references the command-line help but instead of duplicating it, uses it to explain how to do things. Which some of this page already does.

Comment 12

[Atul Varma [:atul]]

Thanks, this looks great!

Pushed:

https://github.com/mozilla/addon-sdk/commit/76c62915073623dbd9947f1269a1222ed854c59e

It seems like we might want to list --use-config as a global option in cfx, then--I'm not sure why I didn't do that when I wrote it... odd.

Agreed about having a page that just reproduces the command-line help. Feel free to make the changes you suggested and just push them, I agree that it'd be both more useful and easier to maintain.