archive/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-08-15 13:48:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

tools: add more details about rolling inspector_protocol

Browse source 
PR-URL: https://github.com/nodejs/node/pull/57167
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
This commit is contained in:
Chengzhong Wu 2025-03-04 12:13:28 +00:00 • committed by GitHub
parent d3064e8ddb
commit f37d2a5809
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 41 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/contributing/maintaining/maintaining-dependencies.md
View file

@ -19,6 +19,7 @@ This a list of all the dependencies:
* [googletest][]
* [histogram][]
* [icu-small][]
* [inspector\_protocol][inspector_protocol]
* [libuv][]
* [llhttp][]
* [minimatch][]
@ -272,6 +273,12 @@ and Java libraries providing Unicode and Globalization
support for software applications.
See [maintaining-icu][] for more information.
### inspector\_protocol
The [inspector\_protocol](https://chromium.googlesource.com/deps/inspector_protocol/)
is Chromium's of code generators and templates for the inspector protocol.
See [this doc](../../../tools/inspector_protocol/README.md) for more information.
### libuv
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).
[googletest]: #googletest
[histogram]: #histogram
[icu-small]: #icu-small
[inspector_protocol]: #inspector_protocol
[libuv]: #libuv
[llhttp]: #llhttp
[maintaining-V8]: ./maintaining-V8.md

35
tools/inspector_protocol/README.md
View file

@ -1,6 +1,37 @@
# Chromium inspector (devtools) protocol
This directory contains scripts to update the [Chromium inspector protocol][]
This directory contains scripts to update the [Chromium `inspector_protocol`][]
to local at `deps/inspector_protocol`.
[Chromium inspector protocol]: https://chromium.googlesource.com/deps/inspector_protocol/
To run the `roll.py`, a local clone of the `inspector_protocol` project is required.
First, you will need to install Chromium's [`depot_tools`][], with `fetch` available
in your `PATH`.
```console
$ cd workspace
/workspace $ mkdir inspector_protocol
/workspace/inspector_protocol $ fetch inspector_protocol
# This will create a `src` directory in the current path.
# To update local clone.
/workspace/inspector_protocol $ cd src
/workspace/inspector_protocol/src $ git checkout main && git pull
```
With a local clone of the `inspector_protocol` project up to date, run the following
commands to roll the dep.
```console
$ cd workspace/node
/workspace/node $ python tools/inspector_protocol/roll.py \
--ip_src_upstream /workspace/inspector_protocol/src \
--node_src_downstream /workspace/node \
--force
# Add --force when you decided to take the update.
```
The `roll.py` requires the node repository to be a clean state (no unstaged changes)
to avoid unexpected overrides.
[`depot_tools`]: https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up
[Chromium `inspector_protocol`]: https://chromium.googlesource.com/deps/inspector_protocol/