From 5ff43006d19dd242d94a25f471ecc83621731ce6 Mon Sep 17 00:00:00 2001 From: Gabriel Schulhof Date: Sat, 6 Oct 2018 05:32:34 -0400 Subject: [PATCH] doc: add link to ABI guide Provides a link from the N-API reference to the guide discussing ABI stability in greater depth. Re: https://github.com/nodejs/abi-stable-node/issues/332 PR-URL: https://github.com/nodejs/node/pull/23287/ Reviewed-By: Sakthipriyan Vairamani Reviewed-By: Rich Trott Reviewed-By: Richard Lau Reviewed-By: Vse Mozhet Byt --- doc/api/n-api.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 5276ee2e54377f..640bd478fdefa7 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -11,8 +11,8 @@ the underlying JavaScript runtime (ex V8) and is maintained as part of Node.js itself. This API will be Application Binary Interface (ABI) stable across versions of Node.js. It is intended to insulate Addons from changes in the underlying JavaScript engine and allow modules -compiled for one version to run on later versions of Node.js without -recompilation. +compiled for one major version to run on later major versions of Node.js without +recompilation. The [ABI Stability][] guide provides a more in-depth explanation. Addons are built/packaged with the same approach/tools outlined in the section titled [C++ Addons](addons.html). @@ -4596,6 +4596,7 @@ idempotent. This API may only be called from the main thread. +[ABI Stability]: https://nodejs.org/en/docs/guides/abi-stability/ [ECMAScript Language Specification]: https://tc39.github.io/ecma262/ [Error Handling]: #n_api_error_handling [Native Abstractions for Node.js]: https://github.com/nodejs/nan