660680 - --strip-xpi should be identified as experimental in docs

Status: RESOLVED FIXED

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

Description

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

The --strip-xpi command-line flag is identified as a "supported" command-line flag in the cfx documentation, but it should be marked "experimental," since it landed late in the cycle, but especially because we expect to make its behavior the default and then remove the flag in the future.

Brian: can you put together a patch for this?

Comment 1

[Brian Warner [:warner :bwarner]]

Attachment: mark --strip-xpi as experimental, in 'cfx --help' and xpi.md

how's this look?

Comment 2

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

Comment on attachment 536352 [details] [diff] [review]
mark --strip-xpi as experimental, in 'cfx --help' and xpi.md

>diff --git a/python-lib/cuddlefish/__init__.py b/python-lib/cuddlefish/__init__.py

>         (("", "--strip-xpi",), dict(dest="strip_xpi",
>-                                    help="remove unused modules from XPI",
>+                                    help="[experimental] remove unused modules from XPI",
>                                     action="store_true",
>                                     default=False,
>                                     cmds=['xpi'])),

Instead of tagging the option in its help text, move it to the separate "parser group" called "Experimental Command-Specific Options" (search for that string in the code to find it), which is the group into which such options should be placed.

Comment 3

[Brian Warner [:warner :bwarner]]

Attachment: better patch, move option into 'experimental' section of --help text

ahh.. I didn't even see that section. Righto, here's an updated patch.

Comment 4

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

Comment on attachment 536535 [details] [diff] [review]
better patch, move option into 'experimental' section of --help text

>+file. (Note: `--strip-xpi` is currently experimental; when this feature is
>+sufficiently mature, it will simply be made the default, and the `cfx` option
>+will be removed).

Nit: ). -> .)

r+a=myk

Comment 5

[Brian Warner [:warner :bwarner]]

Landed (with nit fixed) in https://github.com/mozilla/addon-sdk/commit/cd8764bc760c1f62b969f9cb3e525444b5d8d3a5