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.

Sign up for GitHub

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

Jump to bottom

documentation of --napi-modules #20082

Closed
richardlau opened this issue Apr 16, 2018 · 0 comments
Closed

documentation of --napi-modules #20082

richardlau opened this issue Apr 16, 2018 · 0 comments
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Comments

@richardlau
Copy link
Member

richardlau commented Apr 16, 2018 •
edited
Loading

Looks like the documentation for --napi-modules doesn't match the node --help output.

node/src/node.cc

Lines 3493 to 3494 in 237aa7e

" --napi-modules load N-API modules (no-op - option\n"
" kept for compatibility)\n"

node/doc/node.1

Lines 119 to 121 in 237aa7e

.It Fl -napi-modules
Enable loading native modules compiled with the ABI-stable Node.js API (N-API)
(experimental).

node/doc/api/cli.md

Lines 134 to 140 in 237aa7e

### `--napi-modules`
<!-- YAML
added: v7.10.0
-->
Enable loading native modules compiled with the ABI-stable Node.js API (N-API)
(experimental).

#14902 removed the description from cli.md but not from node.1. #19878 spotted the discrepancy between the files and added it back. I think I'd favour keeping the option listed in the docs, but with the description changed to match the --help output (or similar words) -- It's definitely no longer experimental.

cc @nodejs/n-api
@richardlau richardlau added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Apr 16, 2018
@gabrielschulhof gabrielschulhof mentioned this issue Apr 25, 2018
Closed
3 tasks
gabrielschulhof pushed a commit to gabrielschulhof/node that referenced this issue Apr 25, 2018
n-api: update cli documentation
ae67b29 
Fixes: nodejs#20082
MylesBorins pushed a commit that referenced this issue May 4, 2018
@MylesBorins
n-api: update cli documentation
8d24b6e 
Fixes: #20082
PR-URL: #20301
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

n-api: update cli documentation gabrielschulhof/node
1 participant
@richardlau