Skip to content

Commit 0ee06d9

Browse files
committed
tools: add more details about rolling inspector_protocol
1 parent 8fc919d commit 0ee06d9

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

doc/contributing/maintaining/maintaining-dependencies.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ This a list of all the dependencies:
1919
* [googletest][]
2020
* [histogram][]
2121
* [icu-small][]
22+
* [inspector\_protocol][inspector_protocol]
2223
* [libuv][]
2324
* [llhttp][]
2425
* [minimatch][]
@@ -272,6 +273,12 @@ and Java libraries providing Unicode and Globalization
272273
support for software applications.
273274
See [maintaining-icu][] for more information.
274275

276+
### inspector\_protocol
277+
278+
The [inspector\_protocol](https://chromium.googlesource.com/deps/inspector_protocol/)
279+
is Chromium's of code generators and templates for the inspector protocol.
280+
See [this doc](../../../tools/inspector_protocol/README.md) for more information.
281+
275282
### libuv
276283

277284
The [libuv](https://github.com/libuv/libuv) dependency is a
@@ -411,6 +418,7 @@ according to [RFC 8878](https://datatracker.ietf.org/doc/html/rfc8878).
411418
[googletest]: #googletest
412419
[histogram]: #histogram
413420
[icu-small]: #icu-small
421+
[inspector_protocol]: #inspector_protocol
414422
[libuv]: #libuv
415423
[llhttp]: #llhttp
416424
[maintaining-V8]: ./maintaining-V8.md

tools/inspector_protocol/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,34 @@
33
This directory contains scripts to update the [Chromium inspector protocol][]
44
to local at `deps/inspector_protocol`.
55

6+
To run the `roll.py`, a local clone of the inspector_protocol project is required.
7+
First, you will need to install Chromium's [depot_tools][] installed.
8+
9+
```sh
10+
$ cd workspace
11+
/workspace $ mkdir inspector_protocol
12+
/workspace/inspector_protocol $ fetch inspector_protocol
13+
# This will create a `src` directory in the current path.
14+
15+
# To update local clone.
16+
/workspace/inspector_protocol $ cd src
17+
/workspace/inspector_protocol/src $ git checkout main && git pull
18+
```
19+
20+
With a local clone of the inspector_protocol project up to date, run the following
21+
commands to roll the dep.
22+
23+
```sh
24+
$ cd workspace/node
25+
/workspace/node $ python tools/inspector_protocol/roll.py \
26+
--ip_src_upstream /workspace/inspector_protocol/src \
27+
--node_src_downstream /workspace/node \
28+
--force
29+
# Add --force when you decided to take the update.
30+
```
31+
32+
The `roll.py` requires the node repository to be a clean state (no unstaged changes)
33+
to avoid unexpected overrides.
34+
635
[Chromium inspector protocol]: https://chromium.googlesource.com/deps/inspector_protocol/
36+
[depot_tools]: https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up

0 commit comments

Comments
 (0)