diff --git a/addon-sdk/source/doc/dev-guide-source/cfx-tool.md b/addon-sdk/source/doc/dev-guide-source/cfx-tool.md index b0f4e9b781f..f07540b8822 100644 --- a/addon-sdk/source/doc/dev-guide-source/cfx-tool.md +++ b/addon-sdk/source/doc/dev-guide-source/cfx-tool.md @@ -20,12 +20,69 @@ commands (for example `--help`). `cfx` supports the following global options: -v, --verbose - enable lots of output -"Command-specific options" are only -applicable to a subset of the commands. +"Command-specific options" are documented alongside the commands. -## Supported Commands ## +There are five supported cfx commands: -### cfx docs ### +
+ cfx docs
+ |
+ + Display the documentation for the SDK. + | +
+ cfx init
+ |
+ + Create a skeleton add-on as a starting point for your own add-on. + | +
+ cfx run
+ |
+ + Launch an instance of Firefox with your add-on installed. + | +
+ cfx test
+ |
+ + Runs your add-on's unit tests. + | +
+ cfx xpi
+ |
+ + Package your add-on as an XPI + file, which is the install file format for Firefox add-ons. + | +
+ -o, --overload-modules
+ |
+
+ In early versions of the SDK, the SDK modules used by an add-on + were themselves included in the add-on. The SDK modules now ship as + part of Firefox. From Firefox 21 onwards, SDK add-ons built with + SDK 1.14 or higher will use the SDK modules that are built into Firefox, + even if the add-on includes its own copies of the SDK modules. +Use this flag to reverse that behavior: if this flag is set and + the add-on includes its own copies of the SDK modules, then the add-on + will use the SDK modules in the add-on, not the ones built into Firefox. +This flag is particularly useful for SDK developers or people working with + the development version of the SDK, who may want to run an add-on using newer + versions of the modules than than those shipping in Firefox. + |
+
--templatedir=TEMPLATEDIR
@@ -249,7 +325,7 @@ To launch the application, enter the following command:
|
- --use-server
+ -o, --overload-modules
|
- Run tests using a server previously started with cfx develop .
+ In early versions of the SDK, the SDK modules used by an add-on + were themselves included in the add-on. The SDK modules now ship as + part of Firefox. From Firefox 21 onwards, SDK add-ons built with + SDK 1.14 or higher will use the SDK modules that are built into Firefox, + even if the add-on includes its own copies of the SDK modules. +Use this flag to reverse that behavior: if this flag is set and + the add-on includes its own copies of the SDK modules, then the add-on + will use the SDK modules in the add-on, not the ones built into Firefox. +This flag is particularly useful for SDK developers or people working with + the development version of the SDK, who may want to run an add-on using newer + versions of the modules than than those shipping in Firefox. |
- cfx develop -- -In shell B, type: - -
- cfx test --use-server -- -This will send `cfx test --use-server` output to shell A. If you repeat the -command in shell B, `cfx test --use-server` output will appear again in shell A -without restarting the host application. - -`cfx develop` doesn't take any options. - -## Internal Commands ## +## Internal Commands ## ### cfx sdocs ### diff --git a/addon-sdk/source/doc/module-source/sdk/request.md b/addon-sdk/source/doc/module-source/sdk/request.md index cc439caec69..3f87aefb361 100644 --- a/addon-sdk/source/doc/module-source/sdk/request.md +++ b/addon-sdk/source/doc/module-source/sdk/request.md @@ -6,20 +6,22 @@ The `request` module lets you make simple yet powerful network requests.