bug 1546935: remote: reflect that remote agent is disabled in usage docs; r=me a=doc
authorAndreas Tolfsen <ato@sny.no>
Thu, 25 Apr 2019 12:01:12 +0100
changeset 530097 ec15db17478768038e372a69583e9a76949896f6
parent 530096 8988649ab71dfb53a9d083be8e34f3547a2c4477
child 530098 93e4873ffd1dd508057bd1049750fcf08ad2b1be
push id11265
push userffxbld-merge
push dateMon, 13 May 2019 10:53:39 +0000
treeherdermozilla-beta@77e0fe8dbdd3 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersme, doc
bugs1546935
milestone68.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
bug 1546935: remote: reflect that remote agent is disabled in usage docs; r=me a=doc DONTBUILD
remote/doc/Usage.md
--- a/remote/doc/Usage.md
+++ b/remote/doc/Usage.md
@@ -9,23 +9,22 @@ three different programs/components runn
     and retrieve information out of Firefox;
 
   * the __agent__ that the client connects to which is an HTTPD living
     inside Firefox, facilitating communication between clients
     and targets;
 
   * and the __target__, which is the web document being debugging.
 
-The remote agent is not currently part of the default Firefox build.
-To self-service a build with it built in, you should follow the
-[_Building_] steps in the developer documentation.
+The remote agent currently only ships with builds of [Firefox
+Nightly] and is __not enabled by default__.  To enable it, you must
+flip the [`remote.enabled` preference] to true.
 
-To check if your Firefox binary comes with the remote agent built
-in, you can look in its help message for this:
-
+To check if your Firefox binary has the remote agent enabled, you
+can look in its help message for this:
 
 	% ./firefox -h

 	  --remote-debugging-port <port>
 	  --remote-debugger [<host>][:<port>] Start the Firefox remote agent, which is
 	                     a low-level debugging interface based on the CDP protocol.
 	                     Defaults to listen on localhost:9222.

@@ -60,9 +59,10 @@ listen on port 0, the system will atomic
 free port.
 
 Allocating an atomic port can be useful if you want to avoid race
 conditions.  The atomically allocated port will be somewhere in the
 ephemeral port range, which varies depending on your system and
 system configuration, but is always guaranteed to be free thus
 eliminating the risk of binding to a port that is already in use.
 
-[_Building_]: ./Building.html
+[Firefox Nightly]: https://www.mozilla.org/en-GB/firefox/channel/desktop/#nightly
+[`remote.enabled` preference]: ./Prefs.html