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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

legendecas
Copy link
Member

Add instructions on how to run tools/inspector_tools/roll.py.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the tools Issues and PRs related to the tools directory. label Feb 21, 2025
@legendecas legendecas force-pushed the doc/inspector-protocol branch from 0ee06d9 to f3d0312 Compare February 21, 2025 13:59
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit

Suggested change
First, you will need to install Chromium's [depot_tools][], with `fetch` available
First, you will need to install Chromium's [`depot_tools`][], with `fetch` available

First, you will need to install Chromium's [depot_tools][], with `fetch` available
in your `PATH`.

```sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```sh
```console

With a local clone of the inspector_protocol project up to date, run the following
commands to roll the dep.

```sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```sh
```console

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To run the `roll.py`, a local clone of the inspector_protocol project is required.
To run the `roll.py`, a local clone of the `inspector_protocol` project is required.

/workspace/inspector_protocol/src $ git checkout main && git pull
```

With a local clone of the inspector_protocol project up to date, run the following
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants