doc: document the --with-perfetto build flag - #65056
Conversation
Sorry, something went wrong.
|
Review requested:
|
Sorry, something went wrong.
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
Sorry, something went wrong.
|
I checked doc/api before changing this. A few files there do name configure flags. intl.md has an "Options for building Node.js" section with --with-intl and --with-icu-default-data-dir, including ./configure examples. dtls.md says the module must be enabled at build time with the --experimental-dtls configure flag. ffi.md names --shared-ffi, and crypto.md shows ./configure --openssl-conf-name=<name>. cli.md is different though. It never names a configure flag anywhere. It describes the build condition by its effect instead, like "only available in builds with FFI support" for --experimental-ffi. My line was the only exception in that file, so you are right about it. I pushed a change that keeps --with-perfetto in BUILDING.md only. cli.md and tracing.md now say "builds with Perfetto support" and link to BUILDING.md for the flag itself. I kept the behavior text. --trace-event-file-pattern really does default to a different extension in such a build, and NodeTracing is not registered. That is runtime behavior an API reader can hit, so it seemed worth keeping in doc/api. Happy to drop it if you still think it belongs only in BUILDING.md. |
Sorry, something went wrong.
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.
Sorry, something went wrong.
|
Makes sense, I'll trim it down to BUILDING.md only. |
Sorry, something went wrong.
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>
|
Thanks! |
Sorry, something went wrong.
|
Closing — the underlying issue #65055 was closed by maintainers as not planned. |
Sorry, something went wrong.
The perfetto tracing support added in #64565 was never documented, so there is
no way to find out from the docs that the --with-perfetto configure flag
exists 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-based
collection are not available.
Fixes: #65055