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: improve the visibility of Worker threads cli options #31380

Closed

Conversation

@HarshithaKP
Copy link
Contributor

HarshithaKP commented Jan 16, 2020

fixes: #28518

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
@HarshithaKP HarshithaKP changed the title doc: visibility of Worker threads cli options doc: improve the visibility of Worker threads cli options Jan 16, 2020
@@ -6,6 +6,9 @@
Node.js comes with a variety of CLI options. These options expose built-in
debugging, multiple ways to execute scripts, and other helpful runtime options.

Worker threads inherit non-process-specific options by default. Refer to

This comment has been minimized.

Copy link
@Trott

Trott Jan 18, 2020

Member

Is this a good place for this information? This is in a very prominent place in this document but it only applies to worker threads. This page is the documentation I would look at to figure out what CLI options I want to use. For what worker threads inherit, I would look in the worker_threads docs or maybe at process.argv and friends.

It took me a while to figure out what non-process-specific options means here, but I'm also not coming up with better terminology.

This comment has been minimized.

Copy link
@HarshithaKP

HarshithaKP Jan 23, 2020

Author Contributor

@Trott ,thanks. Added in worker_threads.

@@ -6,6 +6,9 @@
Node.js comes with a variety of CLI options. These options expose built-in
debugging, multiple ways to execute scripts, and other helpful runtime options.

Worker threads inherit non-process-specific options by default. Refer to
[`Worker constructor options`][] to know how to customize worker thread options.

This comment has been minimized.

Copy link
@Trott

Trott Jan 18, 2020

Member

Would it be better to specifically mention the argv and execArgv options? Otherwise, the user may have to do a bit of looking for a needle in a haystack in the worker threads doc.

This comment has been minimized.

Copy link
@HarshithaKP

HarshithaKP Jan 23, 2020

Author Contributor

@Trott, thanks. Mentioned argv and execArgv.

@Trott

This comment has been minimized.

Copy link
Member

Trott commented Jan 18, 2020

@HarshithaKP

This comment has been minimized.

Copy link
Contributor Author

HarshithaKP commented Jan 22, 2020

I am ready to make changes as suggested by @Trott , but would like to get confirmation. I see @addaleax ’s thumbs up on the proposal; so shall I go ahead and make those changes, or wait to hear from the teams you have pinged? (I see 4 days have passed)

@addaleax

This comment has been minimized.

Copy link
Member

addaleax commented Jan 22, 2020

@HarshithaKP You can feel free to go ahead. Sometimes people try to ping relevant teams about PRs so that people who may want to weigh in have a chance to do so, but the pings themselves are mostly background noise.

HarshithaKP added 2 commits Jan 23, 2020
@HarshithaKP

This comment has been minimized.

Copy link
Contributor Author

HarshithaKP commented Feb 4, 2020

@addaleax and @Trott , I have addressed your suggestions and put it in doc/api/worker.md. Please have a look.

@@ -49,6 +49,10 @@ The above example spawns a Worker thread for each `parse()` call. In actual
practice, use a pool of Workers instead for these kinds of tasks. Otherwise, the
overhead of creating Workers would likely exceed their benefit.

Worker threads inherit non-process-specific options by default. Refer to
[`Worker constructor options`][] to know how to customize worker thread options,
specifically `argv` and `execArgv` options.

This comment has been minimized.

Copy link
@addaleax

addaleax Feb 4, 2020

Member

The two paragraphs here belong together; this should be added either above, or (preferably) below them.

This comment has been minimized.

Copy link
@HarshithaKP

HarshithaKP Feb 12, 2020

Author Contributor

@addaleax, Thanks. Put it in the suggested place.

@addaleax addaleax requested a review from Trott Feb 13, 2020
@addaleax

This comment has been minimized.

Copy link
Member

addaleax commented Mar 4, 2020

Landed in 37287d3

@addaleax addaleax closed this Mar 4, 2020
addaleax added a commit that referenced this pull request Mar 4, 2020
Fixes: #28518
PR-URL: #31380
Fixes: #28518
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins added a commit that referenced this pull request Mar 4, 2020
Fixes: #28518
PR-URL: #31380
Fixes: #28518
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Mar 4, 2020
codebytere added a commit that referenced this pull request Mar 16, 2020
Fixes: #28518
PR-URL: #31380
Fixes: #28518
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
codebytere added a commit that referenced this pull request Mar 17, 2020
Fixes: #28518
PR-URL: #31380
Fixes: #28518
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
codebytere added a commit that referenced this pull request Mar 23, 2020
Fixes: #28518
PR-URL: #31380
Fixes: #28518
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
codebytere added a commit that referenced this pull request Mar 30, 2020
Fixes: #28518
PR-URL: #31380
Fixes: #28518
Reviewed-By: Anna Henningsen <anna@addaleax.net>
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
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

5 participants
You can’t perform that action at this time.