doc: document the --with-perfetto build flag - #65056
Conversation
|
Review requested:
|
nodejs-github-bot
added
build
avivkeller
left a comment
avivkeller
left a comment
There was a problem hiding this comment.
We usually don't document configure flags in doc/api, only in the non-user facing docs
|
I checked doc/api before changing this. A few files there do name configure flags.
I pushed a change that keeps I kept the behavior text. |
legendecas
left a comment
legendecas
left a comment
There was a problem hiding this comment.
The build-time flag is not mature enough yet. I'd prefer documenting in BUILDING.md only.
|
Makes sense, I'll trim it down to |
Signed-off-by: Lazizbek Ergashev <lazerg2@gmail.com>
Signed-off-by: Lazizbek Ergashev <lazerg2@gmail.com>
Keep the --with-perfetto flag itself documented in BUILDING.md and refer to a perfetto build by its observable behavior in doc/api, matching how cli.md already describes FFI-gated builds. Signed-off-by: Lazizbek Ergashev <lazerg2@gmail.com>
Revert the doc/api/tracing.md and doc/api/cli.md changes so that the perfetto build is described in one place; the build-time flag is not mature enough to document in the API docs yet. doc/node.1 is left as upstream's already-regenerated version. Signed-off-by: Lazizbek Ergashev <lazerg2@gmail.com>
41ac864 to
dc65fb2
Compare
|
Thanks! |
5 participants
The perfetto tracing support added in #64565 was never documented, so there is
no way to find out from the docs that the
--with-perfettoconfigure flagexists or what it changes.
This adds a short BUILDING.md section for the flag. The trace events and CLI
docs do not name the configure flag. They only describe how a perfetto build
behaves: traces come out as perfetto protobuf, the default trace file name
becomes
node_trace.${rotation}.pftrace, and JSON output and inspector-basedcollection are not available.
Fixes: #65055