Skip to content

documentation of --napi-modules #20082

Closed
Closed
@richardlau

Description

@richardlau

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.node-apiIssues and PRs related to the Node-API.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions