remote/doc/Building.md
author Andreas Tolfsen <ato@sny.no>
Wed, 24 Apr 2019 17:18:44 +0000
changeset 471179 da2d4529a200f41df8978b0310f1f1c9d7f9cb4e
parent 470691 2ff0f3923d0bc5f2f8b3721a0e18fa9b6215aff0
child 471180 8d48c69e7f8e52eec5a7188e343eb6796575dd74
permissions -rw-r--r--
bug 1533831: remote: remove browser.fission.simulate pref; r=ochameau,yulia The browser.fission.simulate preference has been split into two preferences: fission.frontend.simulate-events and fission.frontend.simulate-messages. The remote agent briefly used the child actor system from the Firefox frontend code when we prototyped the initial remote agent, but it no longer relies on it. This means we can drop the reference to browser.fission.simulate altogether. DONTBUILD Differential Revision: https://phabricator.services.mozilla.com/D27538

Building
========

The remote agent is by default not included in Firefox builds.
To build it, put this in your [mozconfig]:

	ac_add_options --enable-cdp

This exposes a `--remote-debugger` flag you can use to start the
remote agent:

	% ./mach run --remote-debugger

When you make changes to the XPCOM component you need to rebuild
in order for the changes to take effect.  The most efficient way to
do this, provided you haven’t touched any compiled code (C++ or Rust):

	% ./mach build faster

Component files include the likes of RemoteAgent.js, RemoteAgent.manifest,
moz.build files, prefs/remote.js, and jar.mn.  All the JS modules
(files ending with `.jsm`) are symlinked into the build and can be
changed without rebuilding.

[mozconfig]: ../build/buildsystem/mozconfigs.html