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: note that v8 options work with both dashes and underscores #6532

Merged

Conversation

Fishrock123
Copy link
Contributor

Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

see #6377 (comment)

This adds docs to the man page and online cli docs that v8 options can be used with either.

r=@nodejs/documentation

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 2, 2016
@@ -111,6 +111,9 @@ Process v8 profiler output generated using the v8 option `--prof`.

Print v8 command line options.

Note: v8 options allow words to be separated by both dashes (`-`) or underscores (`_`).
Copy link
Member

Choose a reason for hiding this comment

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

linewrap

@benjamingr
Copy link
Member

TIL, LGTM minus the line wrap.

@Fishrock123 Fishrock123 force-pushed the doc-v8-options-dash-underscore branch from d698f28 to 6145681 Compare May 9, 2016 15:18
@Fishrock123
Copy link
Contributor Author

@benjamingr & @jasnell lgty?

@benjamingr
Copy link
Member

Yea, go right ahead :)

Note: v8 options allow words to be separated by both dashes (`-`) or underscores
(`_`).

For example, `--stack-trace-limit` is equivalent to `--stack_trace_limit`.
Copy link
Member

Choose a reason for hiding this comment

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

nit: it's likely not worth noting but --stack-trace_limit and --stack_trace-limit are also equivalent.

@jasnell
Copy link
Member

jasnell commented May 9, 2016

Looks fine.

This adds docs to the man page and online cli docs that v8 options can
be used with either dashes or underscores.

Refs: nodejs#6377 (comment)
PR-URL: nodejs#6532
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#6532
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@Fishrock123 Fishrock123 force-pushed the doc-v8-options-dash-underscore branch from 6145681 to 4b107d0 Compare May 9, 2016 16:43
@Fishrock123 Fishrock123 merged commit 4b107d0 into nodejs:master May 9, 2016
@Fishrock123 Fishrock123 deleted the doc-v8-options-dash-underscore branch May 9, 2016 16:44
evanlucas pushed a commit that referenced this pull request May 17, 2016
This adds docs to the man page and online cli docs that v8 options can
be used with either dashes or underscores.

Refs: #6377 (comment)
PR-URL: #6532
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
evanlucas pushed a commit that referenced this pull request May 17, 2016
PR-URL: #6532
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants