From 10f9ab18f7dd42722bf3def5904e5e39f3aeed83 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Tue, 28 May 2019 16:05:28 -0400 Subject: [PATCH 1/6] doc: clarify N-API version Matrix. I was asked by a community member if they needed to recompile for v12.x based on the version matrix. Add additional context to help ensure it is clear that this is not the case. --- doc/api/n-api.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index f648ab1d18f752..55f5d7ec8b021b 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -145,6 +145,12 @@ available to the module code. ## N-API Version Matrix +N-API versions are additive NOT SemVer. Version 4 is an extension +to version 3 in that is has all of the APIs from version 3 with +some additions. This means that you +do NOT need to recompile for new versions of Node.js which are +listed as supporting a later version. + | | 1 | 2 | 3 | 4 | |:-----:|:-------:|:--------:|:--------:|:--------:| | v6.x | | | v6.14.2* | | From 668c02466b9683e9769e03d09019cf48246aa408 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 5 Jun 2019 14:45:51 -0400 Subject: [PATCH 2/6] Update doc/api/n-api.md Co-Authored-By: Rich Trott --- doc/api/n-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 55f5d7ec8b021b..e977a265792468 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -145,7 +145,7 @@ available to the module code. ## N-API Version Matrix -N-API versions are additive NOT SemVer. Version 4 is an extension +N-API versions are additive, not SemVer. Version 4 is an extension to version 3 in that is has all of the APIs from version 3 with some additions. This means that you do NOT need to recompile for new versions of Node.js which are From 70c7833900d5638b0820f0fa322e40dc79746c43 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 5 Jun 2019 14:45:57 -0400 Subject: [PATCH 3/6] Update doc/api/n-api.md Co-Authored-By: Rich Trott --- doc/api/n-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index e977a265792468..7344dc5ddb2373 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -146,7 +146,7 @@ available to the module code. ## N-API Version Matrix N-API versions are additive, not SemVer. Version 4 is an extension -to version 3 in that is has all of the APIs from version 3 with +to version 3 in that it has all of the APIs from version 3 with some additions. This means that you do NOT need to recompile for new versions of Node.js which are listed as supporting a later version. From a6bba0fe52274faee92ba3610d250620dd0e9f8b Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 5 Jun 2019 14:46:24 -0400 Subject: [PATCH 4/6] Update doc/api/n-api.md Co-Authored-By: Rich Trott --- doc/api/n-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 7344dc5ddb2373..52bccea0c28dc6 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -148,7 +148,7 @@ available to the module code. N-API versions are additive, not SemVer. Version 4 is an extension to version 3 in that it has all of the APIs from version 3 with some additions. This means that you -do NOT need to recompile for new versions of Node.js which are +do not need to recompile for new versions of Node.js which are listed as supporting a later version. | | 1 | 2 | 3 | 4 | From 8f3d2e4b1fd188346525f17634b4bbb602daaf56 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 10 Jun 2019 18:40:12 -0400 Subject: [PATCH 5/6] squash: address comments --- doc/api/n-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 52bccea0c28dc6..f97211d107417e 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -145,7 +145,7 @@ available to the module code. ## N-API Version Matrix -N-API versions are additive, not SemVer. Version 4 is an extension +N-API versions are additive and versioned independantly from Node.js. Version 4 is an extension to version 3 in that it has all of the APIs from version 3 with some additions. This means that you do not need to recompile for new versions of Node.js which are From 33b7dd939441019871253f5a4ba7f07dd211bd70 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 10 Jun 2019 19:31:44 -0400 Subject: [PATCH 6/6] squash: fix linter failure --- doc/api/n-api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index f97211d107417e..47d8f79c6780c1 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -145,9 +145,9 @@ available to the module code. ## N-API Version Matrix -N-API versions are additive and versioned independantly from Node.js. Version 4 is an extension -to version 3 in that it has all of the APIs from version 3 with -some additions. This means that you +N-API versions are additive and versioned independantly from Node.js. +Version 4 is an extension to version 3 in that it has all of the APIs +from version 3 with some additions. This means that you do not need to recompile for new versions of Node.js which are listed as supporting a later version.