Skip to content

Commit

Permalink
doc: add note about ABI compatibility
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
MylesBorins authored and rvagg committed Nov 28, 2018
1 parent 27b3583 commit 2459e15
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions BUILDING.md
Expand Up @@ -433,3 +433,14 @@ To make `./myCustomModule.js` available via `require('myCustomModule')`.
```console
> .\vcbuild link-module './myCustomModule.js'
```

## Note for downstream distributors of Node.js

The Node.js ecosystem is reliant on ABI compatibility within a major
release. To maintain ABI compatibility it is required that production
builds of Node.js will be built against the same version of dependencies as the
project vendors. If Node.js is to be built against a different version of a
dependency please create a custom `NODE_MODULE_VERSION` to ensure ecosystem
compatibility. Please consult with the TSC by opening an issue at
https://github.com/nodejs/tsc/issues if you decide to create a custom
`NODE_MODULE_VERSION` so we can avoid duplication in the ecosystem.

0 comments on commit 2459e15

Please sign in to comment.