From 26a029d407be480d791972afb5975cf62c9360a6 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Fri, 19 Apr 2024 02:47:55 +0200 Subject: Adding upstream version 124.0.1. Signed-off-by: Daniel Baumann --- remote/doc/Building.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 remote/doc/Building.md (limited to 'remote/doc/Building.md') diff --git a/remote/doc/Building.md b/remote/doc/Building.md new file mode 100644 index 0000000000..b8ddf5db8d --- /dev/null +++ b/remote/doc/Building.md @@ -0,0 +1,57 @@ +# Building + +The Remote Agent is included in the default Firefox build, but only +ships on the Firefox Nightly release channel: + +```shell +% ./mach run --remote-debugging-port +``` + +The source code can be found under [remote/ in central]. + +There are two build modes to choose from: + +## Full build mode + +The Remote Agent is included when you build in the usual way: + +```shell +% ./mach build +``` + +When you make changes to XPCOM component files 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): + +```shell +% ./mach build faster +``` + +Component files include the likes of components.conf, +RemoteAgent.manifest, moz.build files, and jar.mn. +All the JS modules (files ending with `.jsm`) are symlinked into +the build and can be changed without rebuilding. + +You may also opt out of building all the WebDriver specific components +([Marionette], and the Remote Agent) by setting the following flag in +your [mozconfig]: + +```make +ac_add_options --disable-webdriver +``` + +## Artifact mode + +You may also use [artifact builds] when working on the Remote Agent. +This fast build mode downloads pre-built components from the Mozilla +build servers, rendering local compilation unnecessary. To use +them, place this in your [mozconfig]: + +```make +ac_add_options --enable-artifact-builds +``` + +[remote/ in central]: https://searchfox.org/mozilla-central/source/remote +[mozconfig]: /build/buildsystem/mozconfigs.rst +[artifact builds]: /contributing/build/artifact_builds.rst +[Marionette]: /testing/marionette/index.rst -- cgit v1.2.3