doc: document the --with-perfetto build flag - #65056
Conversation
Signed-off-by: Lazizbek Ergashev <lazerg2@gmail.com>
|
Review requested:
|
Signed-off-by: Lazizbek Ergashev <lazerg2@gmail.com>
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
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>
|
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. |
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