From f3d0312fc0c1d34858d0f80eb4607bfddaf5aa3c Mon Sep 17 00:00:00 2001 From: Chengzhong Wu Date: Fri, 21 Feb 2025 13:53:26 +0000 Subject: [PATCH 1/2] tools: add more details about rolling inspector_protocol --- .../maintaining/maintaining-dependencies.md | 8 +++++ tools/inspector_protocol/README.md | 31 +++++++++++++++++++ 2 files changed, 39 insertions(+) diff --git a/doc/contributing/maintaining/maintaining-dependencies.md b/doc/contributing/maintaining/maintaining-dependencies.md index 3002f045677c1b..ba709c9a8946cb 100644 --- a/doc/contributing/maintaining/maintaining-dependencies.md +++ b/doc/contributing/maintaining/maintaining-dependencies.md @@ -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 diff --git a/tools/inspector_protocol/README.md b/tools/inspector_protocol/README.md index 9b1e3263a86bc3..08c4dea6ccca9c 100644 --- a/tools/inspector_protocol/README.md +++ b/tools/inspector_protocol/README.md @@ -3,4 +3,35 @@ This directory contains scripts to update the [Chromium inspector protocol][] to local at `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`. + +```sh +$ 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. + +```sh +$ 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. + [Chromium inspector protocol]: https://chromium.googlesource.com/deps/inspector_protocol/ +[depot_tools]: https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up From 6cf3fd5cd1b7783ecf724046d2820b1205f9a06f Mon Sep 17 00:00:00 2001 From: Chengzhong Wu Date: Tue, 25 Feb 2025 10:59:27 +0000 Subject: [PATCH 2/2] fixup! tools: add more details about rolling inspector_protocol Co-authored-by: Antoine du Hamel --- tools/inspector_protocol/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/tools/inspector_protocol/README.md b/tools/inspector_protocol/README.md index 08c4dea6ccca9c..1d2a0465d53881 100644 --- a/tools/inspector_protocol/README.md +++ b/tools/inspector_protocol/README.md @@ -1,13 +1,13 @@ # 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`. -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 +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`. -```sh +```console $ cd workspace /workspace $ mkdir inspector_protocol /workspace/inspector_protocol $ fetch inspector_protocol @@ -18,10 +18,10 @@ $ cd workspace /workspace/inspector_protocol/src $ git checkout main && git pull ``` -With a local clone of the inspector_protocol project up to date, run the following +With a local clone of the `inspector_protocol` project up to date, run the following commands to roll the dep. -```sh +```console $ cd workspace/node /workspace/node $ python tools/inspector_protocol/roll.py \ --ip_src_upstream /workspace/inspector_protocol/src \ @@ -33,5 +33,5 @@ $ cd workspace/node The `roll.py` requires the node repository to be a clean state (no unstaged changes) to avoid unexpected overrides. -[Chromium inspector protocol]: https://chromium.googlesource.com/deps/inspector_protocol/ -[depot_tools]: https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up +[`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/