Skip to content

Commit 4dd9464

Browse files
Bug 1694136 - [remote] Move all documentation files for remote protocols under remote/doc r=webdriver-reviewers,whimboo
Depends on D132047 This patch only changes the folder organisation for remote protocol docs. They should still be displayed in the exact same way on https://firefox-source-docs.mozilla.org Differential Revision: https://phabricator.services.mozilla.com/D132049
1 parent fbdf8e9 commit 4dd9464

24 files changed

+76
-39
lines changed

remote/doc/Debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To dump events produced by EventEmitter,
2323
including CDP events produced by the Remote Agent,
2424
you can use the `toolkit.dump.emit` [preference]:
2525

26-
./mach run --setpref "toolkit.dump.emit=true" --remote-debuggiing-port
26+
./mach run --setpref "toolkit.dump.emit=true" --remote-debugging-port
2727

2828

2929
Logging observer notifications
File renamed without changes.

remote/doc/PuppeteerVendor.md remote/doc/cdp/PuppeteerVendor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ process interspersed with some tips.
7474
up for review, run the Puppeteer test job on try again with `--rebuild 10`
7575
to check for stability.
7676

77-
[Testing]: ./Testing.html
77+
[Testing]: ../Testing.html
7878
[Puppeteer test suite]: https://github.com/GoogleChrome/puppeteer/tree/master/test
7979
[re-install the project]: https://github.com/puppeteer/puppeteer/blob/main/CONTRIBUTING.md#getting-code
8080
[run tests against both Chromium and Firefox]: https://github.com/puppeteer/puppeteer/blob/main/test/README.md#running-tests
File renamed without changes.

remote/doc/cdp/index.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
=====================
2+
Remote Protocol (CDP)
3+
=====================
4+
5+
The Firefox **remote protocol (CDP)** is a low-level debugging interface
6+
you can use to inspect the state and control execution of documents
7+
running in web content, instrument the browser in interesting ways,
8+
simulate user interaction for automation purposes, and for subscribing
9+
to updates in the browser such as network- or console logs.
10+
11+
It complements the existing Firefox Developer Tools :ref:`Remote Debugging
12+
Protocol <Remote Debugging Protocol>` (RDP) by implementing a subset of the
13+
`Chrome DevTools Protocol`_ (CDP).
14+
15+
.. _Chrome DevTools Protocol: https://chromedevtools.github.io/devtools-protocol/
16+
17+
.. toctree::
18+
:maxdepth: 1
19+
20+
Usage.md
21+
Architecture.md
22+
PuppeteerVendor.md
23+

remote/doc/index.rst

+48-21
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,69 @@
1-
===============
2-
Remote Protocol
3-
===============
1+
================
2+
Remote Protocols
3+
================
44

5-
The Firefox **remote protocol** is a low-level debugging interface
6-
you can use to inspect the state and control execution of documents
7-
running in web content, instrument the browser in interesting ways,
8-
simulate user interaction for automation purposes, and for subscribing
9-
to updates in the browser such as network- or console logs.
5+
Firefox supports several remote protocols, which allow to inspect and control
6+
the browser, usually for automation purposes:
107

11-
It complements the existing Firefox Developer Tools :ref:`Remote Debugging
12-
Protocol <Remote Debugging Protocol>` (RDP) by implementing a subset of the
13-
`Chrome DevTools Protocol`_ (CDP).
8+
* :ref:`marionette-header`
149

15-
.. _Chrome DevTools Protocol: https://chromedevtools.github.io/devtools-protocol/
10+
* :ref:`remote-protocol-cdp-header`
1611

17-
.. toctree::
18-
:maxdepth: 1
12+
* :ref:`webdriver-bidi-header`
1913

20-
Usage.md
21-
Prefs.md
2214

15+
Common documentation
16+
====================
2317

24-
Internals
25-
=========
18+
The following documentation pages apply to all remote protocols
2619

2720
.. toctree::
2821
:maxdepth: 1
2922

3023
Building.md
3124
Debugging.md
32-
Testing.md
33-
Architecture.md
3425
Prefs.md
26+
Testing.md
3527
CodeStyle.md
36-
PuppeteerVendor.md
3728
Security.md
3829

3930

31+
.. _marionette-header:
32+
33+
Marionette
34+
==========
35+
36+
Marionette is used both by internal tools and testing solutions, but also by
37+
geckodriver to implement the `WebDriver (HTTP) specification`_. The documentation
38+
for Marionette can be found under `testing/marionette`_.
39+
40+
.. _WebDriver (HTTP) specification: https://w3c.github.io/webdriver/
41+
.. _testing/marionette: ../testing/marionette/index.html
42+
43+
44+
.. _remote-protocol-cdp-header:
45+
46+
Remote Protocol (CDP)
47+
=====================
48+
49+
Firefox implements a subset of the `Chrome DevTools Protocol`_ (CDP) in order to
50+
support third party automation tools such as `puppeteer`. The documentation for
51+
the remote protocol (CDP) implement can be found at `remote/cdp`_.
52+
53+
.. _Chrome DevTools Protocol: https://chromedevtools.github.io/devtools-protocol/
54+
.. _remote/cdp: cdp/index.html
55+
56+
57+
.. _webdriver-bidi-header:
58+
59+
WebDriver BiDi
60+
==============
61+
62+
`The WebDriver BiDi specification <https://w3c.github.io/webdriver-bidi>`_
63+
extends WebDriver HTTP to add bidirectional communication. Dedicated
64+
documentation will be added as the Firefox implementation makes progress.
65+
66+
4067
Bugs
4168
====
4269

File renamed without changes.

remote/marionette/doc/CodeStyle.md remote/doc/marionette/CodeStyle.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ TODO
191191
Documentation
192192
-------------
193193

194-
We keep our documentation in-tree under [remote/marionette/doc]
194+
We keep our documentation in-tree under [remote/doc/marionette]
195195
and [testing/geckodriver/doc]. Updates and minor changes to
196196
documentation should ideally not be scrutinised to the same degree
197197
as code changes to encourage frequent updates so that the documentation
@@ -208,7 +208,7 @@ These include public functions—or command implementations—on
208208
the `GeckoDriver` class, as well as all exported symbols from
209209
other modules. Documentation for non-exported symbols is not required.
210210

211-
[remote/marionette/doc]: https://searchfox.org/mozilla-central/source/remote/marionette/doc
211+
[remote/doc/marionette]: https://searchfox.org/mozilla-central/source/remote/marionette/doc
212212
[testing/geckodriver/doc]: https://searchfox.org/mozilla-central/source/testing/geckodriver/doc
213213

214214

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

remote/doc/moz.build

-8
This file was deleted.

remote/marionette/moz.build

-5
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,3 @@ XPCSHELL_TESTS_MANIFESTS += ["test/xpcshell/xpcshell.ini"]
88

99
with Files("**"):
1010
BUG_COMPONENT = ("Testing", "Marionette")
11-
12-
SPHINX_TREES["/testing/marionette"] = "doc"
13-
14-
with Files("doc/**"):
15-
SCHEDULES.exclusive = ["docs"]

remote/moz.build

+1
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ with Files("doc/**"):
1919
SCHEDULES.exclusive = ["docs"]
2020

2121
SPHINX_TREES["/remote"] = "doc"
22+
SPHINX_TREES["/testing/marionette"] = "doc/marionette"

tools/lint/codespell.yml

-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ codespell:
3535
- python/mach/docs/
3636
- python/mozlint/
3737
- remote/doc/
38-
- remote/marionette/doc/
3938
- security/manager/locales/en-US/
4039
- services/sync/locales/en-US/
4140
- taskcluster/docs/

0 commit comments

Comments
 (0)