-
Notifications
You must be signed in to change notification settings - Fork 30k
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
doc: update maintainting V8 guide #17260
Conversation
doc/guides/maintaining-V8.md
Outdated
* On Node.js < 9.0.0: Increase the patch level version in `v8-version.h`. This will not cause any problems with versioning because V8 will not publish other patches for this branch, so Node.js can effectively bump the patch version. | ||
* On Node.js >= 9.0.0: Increase the `v8_embedder_string` number in `common.gypi`. | ||
* In some cases the patch may require extra effort to merge in case V8 has changed substantially. For important issues we may be able to lean on the V8 team to get help with reimplementing the patch. | ||
* Open a cherry-pick PR on nodejs/node targeting the *vY.x-staging* branch and notify the @nodejs/v8 team. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should have backticks around nodejs/node
, to follow the rest of the doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
doc/guides/maintaining-V8.md
Outdated
@@ -289,17 +294,13 @@ To audit for floating patches: | |||
git log --oneline deps/v8 | |||
``` | |||
|
|||
To replace the copy of V8 in Node.js, use the `[update-v8](https://gist.github.com/targos/8da405e96e98fdff01a395bed365b816)` script<sup>2</sup>. For example, if you want to replace the copy of V8 in Node.js with the branch-head for V8 5.1 branch: | |||
To replace the copy of V8 in Node.js, use the [`update-v8`](https://github.com/targos/update-v8) tool. For example, if you want to replace the copy of V8 in Node.js with the branch-head for V8 5.1 branch: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Split to 80 char line lengths while you're here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done. while I was there, I split the entire document to 80 char line lengths and put the links at the bottom.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this!
doc/guides/maintaining-V8.md
Outdated
team to get help with reimplementing the patch. | ||
* Open a cherry-pick PR on `nodejs/node` targeting the *vY.x-staging* branch | ||
and notify the `@nodejs/v8` team. | ||
* Run the Node.js [V8 CI] in addition to the [Node.js CI]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you mention the test-v8
target in the Makefile (and possibly make-v8.sh
)? It takes quite long to actually run locally but mentioning it here at least leaves a pointer about how to update the CI.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can. Do you have a suggestion for the wording?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe Note: The CI uses the `test-v8` target in the `Makefile`, which uses `tools/make-v8.sh` to reconstruct a git tree in the `deps/v8` directory to run V8 tests.
- Mention the now existing Node.js canary branch. - Clearer steps for backporting commits. - Mention that `update-v8` can be used to simplify backports and updates. - Remove section about proposal for floating patches: embedder string has been implemented. - Wrap lines at 80 characters.
- Mention the now existing Node.js canary branch. - Clearer steps for backporting commits. - Mention that `update-v8` can be used to simplify backports and updates. - Remove section about proposal for floating patches: embedder string has been implemented. - Wrap lines at 80 characters. PR-URL: #17260 Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>
Landed in 1b9915f |
- Mention the now existing Node.js canary branch. - Clearer steps for backporting commits. - Mention that `update-v8` can be used to simplify backports and updates. - Remove section about proposal for floating patches: embedder string has been implemented. - Wrap lines at 80 characters. PR-URL: #17260 Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>
- Mention the now existing Node.js canary branch. - Clearer steps for backporting commits. - Mention that `update-v8` can be used to simplify backports and updates. - Remove section about proposal for floating patches: embedder string has been implemented. - Wrap lines at 80 characters. PR-URL: #17260 Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>
Don't think this is worth backporting, but if anyone disagrees feel free to raise backports for v6.x and v8.x. |
update-v8
can be used to simplify backports andupdates.
has been implemented.