|
1 | 1 | # Chromium inspector (devtools) protocol |
2 | 2 | |
3 | | -This directory contains scripts to update the [Chromium inspector protocol][] |
| 3 | +This directory contains scripts to update the [Chromium `inspector_protocol`][] |
4 | 4 | to local at `deps/inspector_protocol`. |
5 | 5 | |
6 | | -[Chromium inspector protocol]: https://chromium.googlesource.com/deps/inspector_protocol/ |
| 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`][], with `fetch` available |
| 8 | +in your `PATH`. |
| 9 | + |
| 10 | +```console |
| 11 | +$ cd workspace |
| 12 | +/workspace $ mkdir inspector_protocol |
| 13 | +/workspace/inspector_protocol $ fetch inspector_protocol |
| 14 | +# This will create a `src` directory in the current path. |
| 15 | + |
| 16 | +# To update local clone. |
| 17 | +/workspace/inspector_protocol $ cd src |
| 18 | +/workspace/inspector_protocol/src $ git checkout main && git pull |
| 19 | +``` |
| 20 | + |
| 21 | +With a local clone of the `inspector_protocol` project up to date, run the following |
| 22 | +commands to roll the dep. |
| 23 | + |
| 24 | +```console |
| 25 | +$ cd workspace/node |
| 26 | +/workspace/node $ python tools/inspector_protocol/roll.py \ |
| 27 | + --ip_src_upstream /workspace/inspector_protocol/src \ |
| 28 | + --node_src_downstream /workspace/node \ |
| 29 | + --force |
| 30 | + # Add --force when you decided to take the update. |
| 31 | +``` |
| 32 | + |
| 33 | +The `roll.py` requires the node repository to be a clean state (no unstaged changes) |
| 34 | +to avoid unexpected overrides. |
| 35 | + |
| 36 | +[`depot_tools`]: https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up |
| 37 | +[Chromium `inspector_protocol`]: https://chromium.googlesource.com/deps/inspector_protocol/ |