Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tools: add more details about rolling inspector_protocol #57167

Merged
merged 2 commits into from
Mar 4, 2025
Merged

tools: add more details about rolling inspector_protocol #57167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3d0312
tools: add more details about rolling inspector_protocol
legendecas Feb 21, 2025
6cf3fd5
fixup! tools: add more details about rolling inspector_protocol
legendecas Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/contributing/maintaining/maintaining-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ This a list of all the dependencies:
* [googletest][]
* [histogram][]
* [icu-small][]
* [inspector\_protocol][inspector_protocol]
* [libuv][]
* [llhttp][]
* [minimatch][]
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
35 changes: 33 additions & 2 deletions tools/inspector_protocol/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/
Loading