Skip to content

Commit 2459e15

Browse files
MylesBorinsrvagg
authored andcommitted
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 <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 27b3583 commit 2459e15

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

BUILDING.md

+11
Original file line numberDiff line numberDiff line change
@@ -433,3 +433,14 @@ To make `./myCustomModule.js` available via `require('myCustomModule')`.
433433
```console
434434
> .\vcbuild link-module './myCustomModule.js'
435435
```
436+
437+
## Note for downstream distributors of Node.js
438+
439+
The Node.js ecosystem is reliant on ABI compatibility within a major
440+
release. To maintain ABI compatibility it is required that production
441+
builds of Node.js will be built against the same version of dependencies as the
442+
project vendors. If Node.js is to be built against a different version of a
443+
dependency please create a custom `NODE_MODULE_VERSION` to ensure ecosystem
444+
compatibility. Please consult with the TSC by opening an issue at
445+
https://github.com/nodejs/tsc/issues if you decide to create a custom
446+
`NODE_MODULE_VERSION` so we can avoid duplication in the ecosystem.

0 commit comments

Comments
 (0)