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: describe NODE_OPTIONS interop w/cmd line opts #28928

Closed

Conversation

reasonablytall
Copy link
Contributor

Checklist
  • make lint passes
  • documentation is changed or added
  • commit message follows commit guidelines

Disambiguates the description of NODE_OPTIONS wrt how it is overrides/compounded by command line options. Adds examples of singleton and multi flags.

Fixes #28910

@nodejs-github-bot nodejs-github-bot added cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. labels Aug 1, 2019
doc/api/cli.md Outdated
NODE_OPTIONS='--require "./my path/file.js"'
```

A singleton flag passed as a command line option will *override* the same flag
Copy link
Member

@Trott Trott Aug 2, 2019

Choose a reason for hiding this comment

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

Optional nit: No need for emphasis?

Suggested change
A singleton flag passed as a command line option will *override* the same flag
A singleton flag passed as a command line option will override the same flag

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed the emphasis, but left singleton in -- happy to follow what you think on that, I think that it can work either way.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, I changed my mind and decided singleton was fine. If there's a better word, it can always be updated in a subsequent PR.

@Trott
Copy link
Member

Trott commented Aug 2, 2019

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 2, 2019
@Trott
Copy link
Member

Trott commented Aug 3, 2019

@Trott
Copy link
Member

Trott commented Aug 4, 2019

Landed in 5eaef7b

@Trott Trott closed this Aug 4, 2019
Trott pushed a commit to Trott/io.js that referenced this pull request Aug 4, 2019
Fixes nodejs#28910

PR-URL: nodejs#28928
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
BridgeAR pushed a commit that referenced this pull request Aug 6, 2019
Fixes #28910

PR-URL: #28928
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: NODE_OPTIONS description is ambiguous/confusing
6 participants