doc: Document the --stack-trace-limit cli flag.

[lance]

Checklist

• documentation is changed or added
• the commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

Partially fixes#6271. This commit
simply documents the V8 cli option --stack_trace_limit but specifies
dashes instead of underscores, which is the Node.js cli convention. I
did not write a test for this, since the behavior hasn't changed. But I
did validate locally that --stack-trace-limit=N works as now
documented.

The issue noted also has a feature request for functional changes to
the stack trace display, potentially filtering Node.js internals. And also,
potentially increasing the Error.stackTraceLimit just for the first tick
for Module.runMain. This PR does not address those requests since
it wasn't really clear to me from the conversation if those were really
desired or needed.

[jasnell]

hmm.. while I don't have a problem with this particular change, we don't typically document v8 command line flags alongside the set provided by Node.js itself. The reason is that those are not under our control to change but as soon as we document it they become our responsibility to maintain. If the v8 team decided to change it's flag, for instance, we'd be forced to either find a way to continue supporting it or do a quick deprecation (which is never ideal).

@nodejs/ctc thoughts?

[mscdex]

I'm -1 on documenting specific v8 options.

[cjihrig]

Also -1 on documenting V8.

[indutny]

-1

[lance]

OK - I was just responding to the issue, trying to hit some low hanging fruit. I am happy to close the PR. Any thoughts on the feature request(s) - either the internals filtering or the increased limit? Personally, I think the increased limit is not the right path to take. Not sure about internals filtering.

[lance]

We're at -3.5 so far. Closing...

[indutny]

@lance filtering internals is not an option in my opinion. This will tremendously complicate the node.js bug report process, since we won't be able to tell what failed and where it broke.

[lance]

@indutny that works for me and fwiw, I agree with earlier sentiment that this info is useful for more than just core committers. Often times it's helped me figure out wtf I was doing wrong in application code. As I said, I was just swinging for low hanging fruit.

[indutny]

@lance no problem at all, sorry it gone this way!

[trevnorris]

Should we possibly make a note somewhere that v8 options accept both underscores and dashes?

[stevemao]

Should we possibly make a note somewhere that v8 options accept both underscores and dashes?

I think we should do that. CC @nodejs/documentation