summaryrefslogtreecommitdiffstats
path: root/remote/doc/Building.md
blob: 210510cc1452cde30d9ae933a645bbab2d9dfbe0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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 `.sys.mjs`) 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