Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add ref to option to enable n-api #13406

Closed
wants to merge 2 commits into from

Conversation

mhdawson
Copy link
Member

@mhdawson mhdawson commented Jun 2, 2017

Since its guarded in by a command line option say
that in the docs and provide the option that needs
to be used to enable it.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, n-api

Since its guarded in by a command line option say
that in the docs and provide the option that needs
to be used to enable it.
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Jun 2, 2017
Copy link
Contributor

@cjihrig cjihrig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

It might be better to add this a little further down, where #include <node_api.h> is first introduced. Feel free to ignore if you want though.

doc/api/n-api.md Outdated
@@ -11,6 +11,13 @@ changes in the underlying JavaScript engine and allow modules
compiled for one version to run on later versions of Node.js without
recompilation.

As the feature is currently experimental it must be enabled with the
following command line option:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: remove currently

@mhdawson
Copy link
Member Author

mhdawson commented Jun 5, 2017

Pushed commit to address comments.

@mhdawson
Copy link
Member Author

mhdawson commented Jun 5, 2017

@mhdawson
Copy link
Member Author

mhdawson commented Jun 5, 2017

GI good, landed as 7d9dfda.

@mhdawson mhdawson closed this Jun 5, 2017
mhdawson added a commit that referenced this pull request Jun 5, 2017
Since its guarded in by a command line option say
that in the docs and provide the option that needs
to be used to enable it.

PR-URL: #13406
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießn <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
@refack
Copy link
Contributor

refack commented Jun 6, 2017

Ohh cool, I'm an options now 😆

jasnell pushed a commit that referenced this pull request Jun 7, 2017
Since its guarded in by a command line option say
that in the docs and provide the option that needs
to be used to enable it.

PR-URL: #13406
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießn <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
@gibfahn gibfahn mentioned this pull request Jun 15, 2017
3 tasks
@mhdawson mhdawson deleted the napi-command-line branch June 28, 2017 19:23
gabrielschulhof pushed a commit to gabrielschulhof/node that referenced this pull request Apr 10, 2018
Since its guarded in by a command line option say
that in the docs and provide the option that needs
to be used to enable it.

PR-URL: nodejs#13406
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießn <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
MylesBorins pushed a commit that referenced this pull request Apr 16, 2018
Since its guarded in by a command line option say
that in the docs and provide the option that needs
to be used to enable it.

Backport-PR-URL: #19447
PR-URL: #13406
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießn <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Apr 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants