Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 6768751

Browse filesBrowse files
MylesBorinstargos
MylesBorins
authored and
targos
committed
doc: add note about ABI compatibility
Building node against versions of the dependencies that differ from the ones we vendor will result in a non ABI compatible version of Node.js This patch adds a note to make it explicit that if individuals build node against different versions of a dependency they should make a custom NODE_MODULE_VERSION. PR-URL: #22237 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent ed10a91 commit 6768751
Copy full SHA for 6768751

File tree

Expand file treeCollapse file tree

1 file changed

+11
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+11
-0
lines changed
Open diff view settings
Collapse file

‎BUILDING.md‎

Copy file name to clipboardExpand all lines: BUILDING.md
+11Lines changed: 11 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -528,3 +528,14 @@ To make `./myModule.js` available via `require('myModule')` and
528528
```console
529529
> .\vcbuild link-module './myModule.js' link-module './myModule2.js'
530530
```
531+
532+
## Note for downstream distributors of Node.js
533+
534+
The Node.js ecosystem is reliant on ABI compatibility within a major
535+
release. To maintain ABI compatibility it is required that production
536+
builds of Node.js will be built against the same version of dependencies as the
537+
project vendors. If Node.js is to be built against a different version of a
538+
dependency please create a custom `NODE_MODULE_VERSION` to ensure ecosystem
539+
compatibility. Please consult with the TSC by opening an issue at
540+
https://github.com/nodejs/tsc/issues if you decide to create a custom
541+
`NODE_MODULE_VERSION` so we can avoid duplication in the ecosystem.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.