Repository navigation
--prof flag not documented in --help output #16459
Description
Activity
The description from
--prof-processhints at it:--profis a V8 flag listed under--v8-options.We could put something in like "if the option you are looking for is not here, try
--v8-options". Thoughts?In this case, I wasn't totally sure what option I was looking for; I was checking help to remind myself of the name. I think now that
--profis officially documented as the way to do profiling, it might be good to hoist it from the (mostly obscure)--v8-options.Another possibility to make it more clear that there is additional help available would be to rename or alias
--v8-optionsto--help-v8, or--help-all.Reacted by Gireesh Punathil@jsha - just wondering you want to put together a doc PR to this effect? let me know. Or else we could open this up for
good-first-contributiontoo.- Let's tag it with good-first-contribution. Thanks!…On Wed, May 16, 2018, 03:43 Gireesh Punathil ***@***.***> wrote: @jsha <https://github.com/jsha> - just wondering you want to put together a doc PR to this effect? let me know. Or else we could open this up for good-first-contribution too. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#16459 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AANcLV2dtNZS3t0wpDtoeTCNdJN6DzOPks5tzAK8gaJpZM4QFFGl> .
Is
--profofficially supported by V8? I am under the impression that only the CPU profiler is officially supported and thoroughly tested. cc @nodejs/v8Yeah. --prof is somewhat of a grey area. We have some long term plans to fold it into a better way for logging/tracing.
so what is the recommendation here? document (
--profin Node) or leave it to status quo?- In my opinion, even experimental / temporary things should have some documentation. For one thing, it helps people to understand that they are experimental or temporary.…On Wed, May 16, 2018, 18:53 Gireesh Punathil ***@***.***> wrote: so what is the recommendation here? document (--prof in Node) or leave it to status quo? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#16459 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AANcLYTii5UPnKvvkOJeKU395u3q77vKks5tzNf_gaJpZM4QFFGl> .Reacted by Gireesh Punathil
Agreed - in addition,
--profcurrently provides vital diagnostic data for performance problem determination. Experimental or non-experimental, its value is great, and should not go under-utlized due to the under-documented nature of it.Call for good first contributors!
May I work on this issue?
Reacted by Yuta Hiroto and Gireesh Punathil- added a commit that references this issue
on May 25, 2018 - added a commit that references this issue
on Jul 27, 2026
Steps to reproduce:
Run
node --helpExpected result:
Output includes short documentation for
--profflag, as described at https://nodejs.org/en/docs/guides/simple-profiling/.Actual result:
Output does not include that documentation (but does include documentation for
--prof-process).