620555 - cfx Tool doc should mention that you can use --profiledir to run Firebug

Status: RESOLVED FIXED

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

Description

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

The cfx Tool doc should mention that you can use the --profiledir option to run Firebug and other extensions.

Comment 1

[Will Bamberg [:wbamberg]]

Attachment: Add --profiledir help, and some other cleanup

This patch adds some more information about the --profiledir option, and adds information about --update-link and --update-url, so should also fix bug 620557.

I've also cleaned up the look of this page a bit, and added a kind of overview section introducing important options for each command.

Comment 2

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

Comment on attachment 518455 [details] [diff] [review]
Add --profiledir help, and some other cleanup

Dietrich: can you take on this review?

Comment 3

[Dietrich Ayala (:dietrich)]

Comment on attachment 518455 [details] [diff] [review]
Add --profiledir help, and some other cleanup

Hi Will, a slew of changes, but all of them minor. This looks awesome, thanks! r=me with the changes made.

>---------
>+"Command-specific options" are only
>+applicable to some subset of the commands.

s/some/a/

>-#### `cfx docs` ####
>+### cfx docs ###
> 
> This command launches a mini-server on the localhost to view web-based
> documentation in a new Firefox window.

While here, can you change mini-server to HTTP server?

> 
>-#### `cfx init` ####
>-
>+### cfx init ####
> Just create a new directory, change into it, and run `cfx init`.

s/Just//


>+#### Supported Options #####
>+
>+You can point `cfx run` at a different `package.json` file using the
>+`--pkgdir` option, and pass arguments to your add-on using the
>+`--static-args` option.
>+
>+You can specify a different version of the
>+<a href="dev-guide/appendices/glossary.html#host-application">host application</a>
>+using the `--binary` option, passing in the path to the application binary to
>+run. But note that the version must be 4.0b7 or later.

full or relative path? either works?

>+<tr>
>+  <td>
>+    <code>--extra-packages=EXTRA_PACKAGES</code>
>+  </td>
>+  <td>
>+    Extra packages to include, specified as a comma-separated list. Defaults
>+    to <code>addon-kit</code>.
>+  </td>
>+</tr>

"list of package names"

>+<tr>
>+  <td>
>+    <code>-p PROFILEDIR, --profiledir=PROFILEDIR</code>
>+  </td>
>+  <td>
>+    Use an existing
>+    <a href="http://support.mozilla.com/en-US/kb/profiles">profile</a>
>+    located in PROFILEDIR.
>+  </td>
>+</tr>

full or relative path?

>+
>+<tr>
>+  <td>
>+    <code>--pkgdir=PKGDIR</code>
>+  </td>
>+  <td>
>+    Use an add-on located in PKGDIR.
>+  </td>
>+</tr>

ditto

>+
>+<tr>
>+  <td>
>+    <code>--static-args=STATIC_ARGS</code>
>+  </td>
>+  <td>
>+    <a href="dev-guide/addon-development/cfx-tool.html#arguments">Pass arguments to your add-on</a>, specified as JSON.
>+  </td>
>+</tr>

s/specified/in JSON format/


>+<tr>
>+  <td>
>+    <code>-a APP, --app=APP</code>
>+  </td>
>+  <td>
>+    Specify a different
>+    <a href="dev-guide/appendices/glossary.html#host-application">host application</a>.
>+  </td>
>+</tr>

Different from Firefox? Should make clear how this is this different from specifying a different binary.

>+  <td>
>+    <code>--addons=ADDONS</code>
>+  </td>
>+  <td>
>+    Paths of add-ons to install, comma-separated.
>+  </td>

full or relative

>+</tr>
>+<tr>
>+  <td>
>+    <code>--e10s</code>
>+  </td>
>+  <td>
>+    Enable <a href="dev-guide/module-development/e10s.html">out-of-process add-ons</a>.
>+  </td>
>+</tr>

does this make the developer's add-on run fully out of process? if so, say that. as is, sounds a bit abstract.

>+
>+### cfx test ###
>+
>+Run available tests for the specified package.
>+
>+Called with no options this command will look for a file called `package.json`
>+in the current directory. If it finds one it will look for a `tests` directory
>+under the current directory, load any modules that start with the word `test`
>+and call each of their exported functions, passing them a
>+[test runner](packages/api-utils/docs/unit-test.html) object as an argument.

minor clarification: seems obvious, but might note that it loads the add-on in the package and then runs it's tests.


>+<table>
>+<colgroup>
>+<col width="50%">
>+<col width="50%">
>+</colgroup>
>+<tr>
>+  <td>
>+    <code>-b BINARY, --binary=BINARY</code>
>+  </td>
>+  <td>
>+    Use the host application binary specified in BINARY.
>+  </td>

provide clarification that it's a path, and what kind

>+<tr>
>+  <td>
>+    <code>--dependencies</code>
>+  </td>
>+  <td>
>+    Run tests for packages your package depends on.
>+  </td>
>+</tr>

minor clarification: s/for/in/ or some way to make clear it's referring to tests packaged in those other packages.

>+
>+<tr>
>+  <td>
>+    <code>-f FILTER, --filter=FILTER</code>
>+  </td>
>+  <td>
>+    Run only those test modules whose names match the regexp supplied in
>+    FILTER.
>+  </td>
>+</tr>

an example here would be cool

>+<tr>
>+  <td>
>+    <code>-p PROFILEDIR, --profiledir=PROFILEDIR</code>
>+  </td>
>+  <td>
>+    Use an existing
>+    <a href="http://support.mozilla.com/en-US/kb/profiles">profile</a>
>+    located in PROFILEDIR.
>+  </td>
>+</tr>

clarify full/relative path

>+#### Experimental Options ####

>+#### Internal Options ####

comments here were all ditto of above comments on same options.

>+<tr>
>+  <td>
>+    <code>--profile-memory=PROFILEMEMORY</code>
>+  </td>
>+  <td>
>+    Profile memory usage.
>+  </td>
>+</tr>
>+<tr>

Should say what that means (eg: "Dumps detailed memory usage information to the console on application exit.")


>+Called with no options, this command looks for a file called `package.json` in
>+the current directory and creates the corresponding XPI file.

instead of "corresponding", could say something like "an XPI file, which is a packaged version of your add-on, ready for installation into an application'. but that might be not necessary considering the audience here...


>+To do this you include a URL in the XPI called the
>+[updateURL](https://developer.mozilla.org/en/install_manifests#updateURL): the

"To do this, include"


>+#### Supported Options ####

ditto comments about paths, package names, etc.


>+### cfx sdocs ###
>+
>+Executing this command builds a version of the SDK documentation that can be
>+hosted on a web server without the special application support required by
>+`cfx docs`.

"builds a static HTML version"

Comment 4

[Will Bamberg [:wbamberg]]

Fixed, with review comments addressed, by: https://github.com/mozilla/addon-sdk/commit/5dcceb79689899e0052eb677947a0d6957202564